readme: deprecation notice (#28)

ariga · Oct 15, 2023 · 2ca31f5 · 2ca31f5
1 parent 4f7e591
commit 2ca31f5
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1,5 +1,14 @@
 # atlas-sync-action
 
+## Deprecation Notice
+
+This action has been deprecated in favor of the `ariga/atlas-action/migrate/push` action.
+
+Please see [the docs](https://github.com/ariga/atlas-action#arigaatlas-actionmigratepush) for more
+details.
+
+## About
+
 A GitHub Action for syncing a migration directory to [Atlas Cloud](https://atlasgo.cloud).
 
 ## Usage

diff --git a/action.yml b/action.yml
@@ -1,5 +1,5 @@
 name: 'atlas-sync-action'
-description: 'Sync your migration directory to Atlas Cloud'
+description: 'Deprecated. Sync your migration directory to Atlas Cloud'
 branding:
   icon: database
 author: 'Ariga'

diff --git a/main.go b/main.go
@@ -24,6 +24,8 @@ const cloudDomainPublic = "https://gh-api.atlasgo.cloud"
 
 func main() {
 	act := githubactions.New()
+	act.Warningf("This action is deprecated. Please use ariga/atlas-action/migrate/push instead. " +
+		"For details see: https://github.com/ariga/atlas-action#arigaatlas-actionmigratepush")
 	if ok, err := strconv.ParseBool(act.GetInput("cloud-public")); err == nil && ok {
 		RunPublic(act)
 	} else {