From f6fbb533e84dc2743ac8f7f29d5dd39c8b65cd06 Mon Sep 17 00:00:00 2001 From: Tomas Sebestik Date: Wed, 14 Feb 2024 09:44:50 +0100 Subject: [PATCH] change(jira-sync-actions): add deprecation info and warning message --- sync_issues_to_jira/README.md | 4 ++++ sync_issues_to_jira/action.yml | 4 ++-- sync_issues_to_jira/sync_to_jira.py | 9 +++++++++ 3 files changed, 15 insertions(+), 2 deletions(-) diff --git a/sync_issues_to_jira/README.md b/sync_issues_to_jira/README.md index b4b0194..eb123d9 100644 --- a/sync_issues_to_jira/README.md +++ b/sync_issues_to_jira/README.md @@ -1,3 +1,7 @@ +:warning: **Deprecation Notice**: This GitHub action is deprecated and development will not continue here. We recommend migrating to the latest version available in the [espressif/sync-jira-actions](https://github.com/espressif/sync-jira-actions) project. + +--- + # GitHub to JIRA Issue Sync This is a GitHub action that performs simple one way syncing of GitHub issues into JIRA. diff --git a/sync_issues_to_jira/action.yml b/sync_issues_to_jira/action.yml index 109385e..30ef786 100644 --- a/sync_issues_to_jira/action.yml +++ b/sync_issues_to_jira/action.yml @@ -1,5 +1,5 @@ -name: "GitHub to JIRA Issue Sync" -description: "Performs simple one way syncing of GitHub issues into JIRA." +name: "GitHub to JIRA Issue Sync [Deprecated]" +description: "DEPRECATED: Performs simple one-way syncing of GitHub issues into JIRA. Please migrate to the new action at https://github.com/espressif/sync-jira-actions." branding: icon: "fast-forward" color: "green" diff --git a/sync_issues_to_jira/sync_to_jira.py b/sync_issues_to_jira/sync_to_jira.py index 924db37..4b0893f 100755 --- a/sync_issues_to_jira/sync_to_jira.py +++ b/sync_issues_to_jira/sync_to_jira.py @@ -14,6 +14,14 @@ # See the License for the specific language governing permissions and # limitations under the License. # +import warnings +warnings.simplefilter('default', DeprecationWarning) +warnings.warn( + "You are using a deprecated version of the Jira sync GitHub action. " + "We recommend migrating to the latest version available at https://github.com/espressif/sync-jira-actions.", + DeprecationWarning +) + from jira import JIRA from github import Github import os @@ -23,6 +31,7 @@ from sync_issue import * + class _JIRA(JIRA): def applicationlinks(self): return [] # disable this function as we don't need it and it makes add_remote_links() slow