From e1944a69e649c3cfe225c03bc3ab8470d71d95ee Mon Sep 17 00:00:00 2001 From: Yigit Polat Date: Wed, 6 Nov 2024 16:53:47 +0100 Subject: [PATCH] BUG: fix Ansible Lint workflow failures (#28) - Self-hosted runner changed into GitHub-hosted runner. - Code of Conduct was deleted from issues template. I think its bit too much in every issue. - Slack channel information fixed. - Security report template delated as GitHub already has a default template for security issues. --- .github/CONTRIBUTING.md | 2 +- .github/ISSUE_TEMPLATE/config.yml | 2 +- .github/ISSUE_TEMPLATE/security_report.md | 67 ------------------- .github/PULL_REQUEST_TEMPLATE.md | 4 -- .../docs_pull_request_template.md | 7 -- .../pull_request_template.md | 20 ------ .../ansible-lint-self-hosted.yml} | 2 +- .../workflows/ansible-lint-github-hosted.yml | 40 +++++++++++ .github/workflows/gh-pages.yml | 7 +- .github/workflows/issues-close-inactive.yml | 19 ++++++ .github/workflows/issues-find-inactive.yml | 20 ++++++ .github/workflows/issues-notify-inactive.yml | 21 ++++++ .github/workflows/issues-remove-inactive.yml | 21 ++++++ .../token_refresh_automation_hub.yml | 14 ++++ .../token_refresh_rh_subscription_manager.yml | 14 ++++ README.adoc | 64 ------------------ README.md | 2 +- docs/ansible_practices.md | 4 +- docs/branch_standards.md | 2 +- docs/general_guidelines.md | 54 ++------------- docs/onboarding.md | 19 +----- docs/slack_integration.md | 16 +---- 22 files changed, 165 insertions(+), 256 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/security_report.md delete mode 100644 .github/PULL_REQUEST_TEMPLATE/docs_pull_request_template.md delete mode 100644 .github/PULL_REQUEST_TEMPLATE/pull_request_template.md rename .github/{workflows/ansible-lint.yml => disabled_workflows/ansible-lint-self-hosted.yml} (98%) create mode 100644 .github/workflows/ansible-lint-github-hosted.yml create mode 100644 .github/workflows/issues-close-inactive.yml create mode 100644 .github/workflows/issues-find-inactive.yml create mode 100644 .github/workflows/issues-notify-inactive.yml create mode 100644 .github/workflows/issues-remove-inactive.yml create mode 100644 .github/workflows/token_refresh_automation_hub.yml create mode 100644 .github/workflows/token_refresh_rh_subscription_manager.yml delete mode 100644 README.adoc diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 07ed888..4dddfd4 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -1,6 +1,6 @@ # Contributor's Guidelines -Refer to the [Contributing guidelines](https://docs.ansible.com/ansible/devel/community/index.html) for basic guideline. +Refer to the [Ansible Community Guide](https://docs.ansible.com/ansible/devel/community/index.html) for basic guideline. ## General Guidance When making a contribution to the repositories of the Red Hat Communities of Practice, try to utilize the following set of guidelines outlined in this section. Committers should adhere to these practices as they attempt to address many (but not all) of the primary concerns associated with open source repositories and project management: diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 576c4f7..409ad75 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -6,5 +6,5 @@ contact_links: url: https://docs.ansible.com/ansible/latest/community/code_of_conduct.html about: Be nice to other members of the community. Behave. - name: 💬 Talk to Steering Committee - url: https://redhat.enterprise.slack.com/archives/C06VCEWRQE4 + url: https://redhat.enterprise.slack.com/archives/C07TAP5PJ8K about: Reach out to the Red Hat Community diff --git a/.github/ISSUE_TEMPLATE/security_report.md b/.github/ISSUE_TEMPLATE/security_report.md deleted file mode 100644 index e1b052d..0000000 --- a/.github/ISSUE_TEMPLATE/security_report.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -name: 🔐 Security Bug Report -about: Report security bug here -title: 'SEC:' -labels: security, new -assignees: '' - ---- -## Security Bug Report - -### ⚠️ **Security Disclosure Process** - -If you’ve found a security issue, **DO NOT** disclose it publicly. Instead, follow the responsible disclosure policy or contact the maintainers directly. Security issues must be handled with care to avoid unnecessary exposure. - ---- - -## Description - -**Provide a clear and detailed description of the security issue.** - -- What is the vulnerability or security concern? -- How can this affect the project or its users? - ---- - -## Steps to Reproduce - -**If applicable, provide steps to reproduce the security issue:** - -1. Step 1 -2. Step 2 -3. Step 3 - ---- - -## Impact - -**Describe the potential impact of this security issue.** - -- Data breach? Unauthorized access? Denial of service? Privilege escalation? etc. - ---- - -## Environment - -**Provide details about the environment where the issue occurs:** - -- OS: (e.g. Windows, macOS, Linux) -- Project version: (e.g. v1.0.0) -- Dependencies: (e.g. third-party libraries) -- Other relevant configurations: - ---- - -## Mitigation Recommendations - -**Suggest any potential fixes or mitigation steps, if known.** - ---- - -## Additional Information - -**Include any additional information or context that might help address the security issue (e.g., logs, screenshots, etc.).** - ---- - -**Reminder:** Please do not disclose this security issue publicly until it has been properly addressed. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 57d6582..073ad6e 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -2,10 +2,6 @@ -## Connected Jira issues - -* https://issues.redhat.com/browse/SHWRM-xxx - ## Connected merge requests diff --git a/.github/PULL_REQUEST_TEMPLATE/docs_pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/docs_pull_request_template.md deleted file mode 100644 index e9a2a9a..0000000 --- a/.github/PULL_REQUEST_TEMPLATE/docs_pull_request_template.md +++ /dev/null @@ -1,7 +0,0 @@ -## Summary - - - -## Connected GitHub issues - -* https://github.com/redhat-cop/rhis-code/issues/xxx diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md deleted file mode 100644 index e5186a9..0000000 --- a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md +++ /dev/null @@ -1,20 +0,0 @@ -## Summary - - - -## Connected GitHub issue - -* https://github.com/redhat-cop/rhis-code/issues/xxx - -## Connected merge requests - - - -* https://github.com/redhat-cop/rhis-inventory/pull/xxx - -## Functional test - - diff --git a/.github/workflows/ansible-lint.yml b/.github/disabled_workflows/ansible-lint-self-hosted.yml similarity index 98% rename from .github/workflows/ansible-lint.yml rename to .github/disabled_workflows/ansible-lint-self-hosted.yml index 95f127e..b88d167 100644 --- a/.github/workflows/ansible-lint.yml +++ b/.github/disabled_workflows/ansible-lint-self-hosted.yml @@ -1,5 +1,5 @@ --- -name: Ansible Lint +name: Ansible Lint on Self-Hosted Runner run-name: ansible-lint validation on PR-${{ github.event.pull_request.number }} on: pull_request: diff --git a/.github/workflows/ansible-lint-github-hosted.yml b/.github/workflows/ansible-lint-github-hosted.yml new file mode 100644 index 0000000..d3fef91 --- /dev/null +++ b/.github/workflows/ansible-lint-github-hosted.yml @@ -0,0 +1,40 @@ +--- +name: Ansible Lint on GitHub-Hosted Runner +run-name: ansible-lint validation on PR-${{ github.event.pull_request.number }} +on: + pull_request: + branches: ["main", "devel"] +jobs: + ansible-lint: + name: Ansible Lint + runs-on: ubuntu-latest + steps: + - name: Git checkout + uses: actions/checkout@v4 + + - name: Populate ansible config + run: | + cat < ansible.cfg + [defaults] + collections_path = ./collections:./imported/collections + roles_path = ./roles:./imported:./imported/roles + + [galaxy] + server_list = automation_hub_published, automation_hub_validated, galaxy + + [galaxy_server.automation_hub_published] + url=https://console.redhat.com/api/automation-hub/content/published/ + auth_url=https://sso.redhat.com/auth/realms/redhat-external/protocol/openid-connect/token + token=${{ secrets.RH_AUTOMATION_HUB_TOKEN }} + + [galaxy_server.automation_hub_validated] + url=https://console.redhat.com/api/automation-hub/content/validated/ + auth_url=https://sso.redhat.com/auth/realms/redhat-external/protocol/openid-connect/token + token=${{ secrets.RH_AUTOMATION_HUB_TOKEN }} + + [galaxy_server.galaxy] + url=https://galaxy.ansible.com/ + EOF + + - name: Run ansible-lint + uses: ansible/ansible-lint@main diff --git a/.github/workflows/gh-pages.yml b/.github/workflows/gh-pages.yml index 45c30ba..7520e6e 100644 --- a/.github/workflows/gh-pages.yml +++ b/.github/workflows/gh-pages.yml @@ -1,5 +1,6 @@ --- name: Deploy to GitHub Pages +run-name: Deploy to GitHub Pages on: push: branches: @@ -19,11 +20,6 @@ jobs: steps: - name: Checkout uses: actions/checkout@v4 - # Not available for private repo - # - name: Markdown lint - # uses: DavidAnson/markdownlint-cli2-action@v9 - # with: - # globs: '**/*.md' - run: pip install mkdocs-material - run: mkdocs build - name: Setup Pages @@ -31,7 +27,6 @@ jobs: - name: Upload artifact uses: actions/upload-pages-artifact@v3 with: - # Upload entire repository path: './site' - name: Deploy to GitHub Pages id: deployment diff --git a/.github/workflows/issues-close-inactive.yml b/.github/workflows/issues-close-inactive.yml new file mode 100644 index 0000000..c35062f --- /dev/null +++ b/.github/workflows/issues-close-inactive.yml @@ -0,0 +1,19 @@ +--- +# https://github.com/marketplace/actions/issues-helper +name: Check and close inactive + +on: + schedule: + - cron: "0 6 * * *" + +jobs: + close-inactive-issues: + runs-on: ubuntu-latest + steps: + - name: close-issues + uses: actions-cool/issues-helper@v3 + with: + actions: 'close-issues' + token: ${{ secrets.GITHUB_TOKEN }} + labels: 'inactive' + inactive-day: 7 diff --git a/.github/workflows/issues-find-inactive.yml b/.github/workflows/issues-find-inactive.yml new file mode 100644 index 0000000..685f5ee --- /dev/null +++ b/.github/workflows/issues-find-inactive.yml @@ -0,0 +1,20 @@ +--- +# https://github.com/marketplace/actions/issues-helper +name: Check inactive + +on: + schedule: + - cron: "0 5 * * *" + +jobs: + check-inactive: + runs-on: ubuntu-latest + steps: + - name: check-inactive + uses: actions-cool/issues-helper@v3 + with: + actions: 'check-inactive' + token: ${{ secrets.GITHUB_TOKEN }} + inactive-day: 30 + issue-state: open + exclude-labels: 'bug,documentation,enhancement,invalid' diff --git a/.github/workflows/issues-notify-inactive.yml b/.github/workflows/issues-notify-inactive.yml new file mode 100644 index 0000000..2fe8a06 --- /dev/null +++ b/.github/workflows/issues-notify-inactive.yml @@ -0,0 +1,21 @@ +--- +# https://github.com/marketplace/actions/issues-helper +name: Issue Labeled + +on: + issues: + types: [labeled] + +jobs: + issue-labeled: + runs-on: ubuntu-latest + steps: + - name: Create comment + uses: actions-cool/issues-helper@v3 + if: github.event.label.name == 'inactive' + with: + actions: 'create-comment' + token: ${{ secrets.GITHUB_TOKEN }} + issue-number: ${{ github.event.issue.number }} + body: | + Hello @${{ github.event.issue.user.login }}. Please ensure that you have filled out the issue template as much as possible and have answered any further questions asked. If you have not done so in the next 7 days this issue will be automatically closed.' diff --git a/.github/workflows/issues-remove-inactive.yml b/.github/workflows/issues-remove-inactive.yml new file mode 100644 index 0000000..e882e77 --- /dev/null +++ b/.github/workflows/issues-remove-inactive.yml @@ -0,0 +1,21 @@ +--- +# https://github.com/marketplace/actions/issues-helper +name: Issue Remove Labels + +on: + issues: + types: [edited, reopened, labeled] + issue_comment: + types: [created, edited] + +jobs: + remove-inactive: + runs-on: ubuntu-latest + steps: + - name: remove inactive + if: github.event.issue.state == 'open' && github.event.issue.user != 'github-actions' + uses: actions-cool/issues-helper@v3 + with: + actions: 'remove-labels' + issue-number: ${{ github.event.issue.number }} + labels: 'inactive' diff --git a/.github/workflows/token_refresh_automation_hub.yml b/.github/workflows/token_refresh_automation_hub.yml new file mode 100644 index 0000000..c28f127 --- /dev/null +++ b/.github/workflows/token_refresh_automation_hub.yml @@ -0,0 +1,14 @@ +--- +name: Refresh the automation hub token +# the token expires every 30 days, so we need to refresh it +on: + schedule: + - cron: "0 12 1,15 * *" # run 12pm on the 1st and 15th of the month + workflow_dispatch: +jobs: + refresh: + uses: ansible/team-devtools/.github/workflows/ah_token_refresh.yml@main + with: + environment: release + secrets: + ah_token: ${{ secrets.RH_AUTOMATION_HUB_TOKEN }} diff --git a/.github/workflows/token_refresh_rh_subscription_manager.yml b/.github/workflows/token_refresh_rh_subscription_manager.yml new file mode 100644 index 0000000..5098311 --- /dev/null +++ b/.github/workflows/token_refresh_rh_subscription_manager.yml @@ -0,0 +1,14 @@ +--- +name: Refresh the RHSM token +# the token expires every 30 days, so we need to refresh it +on: + schedule: + - cron: "0 12 1,15 * *" # run 12pm on the 1st and 15th of the month + workflow_dispatch: +jobs: + refresh: + uses: ansible/team-devtools/.github/workflows/ah_token_refresh.yml@main + with: + environment: release + secrets: + ah_token: ${{ secrets.RHSM_TOKEN }} diff --git a/README.adoc b/README.adoc deleted file mode 100644 index cff9b8e..0000000 --- a/README.adoc +++ /dev/null @@ -1,64 +0,0 @@ -//// -author: Showroom Project Team -company: Red Hat, Inc. -license: GPL-3.0-only -//// - -:subject: Showroom Code -:description: This document explains Showroom Project -:doctype: book -:chapter-label: -:imagesdir: ./images -:encoding: UTF-8 -:lang: en -:autofit-option: -:url-org: https://github.com/showroom-project -:url-repo: {url-org}/showroom-code -:url-inventory-repo: {url-org}/showroom-inventory - -= {subject} - -image:https://github.com/showroom-project/showroom-code/actions/workflows/ansible-lint.yml/badge.svg[Ansible Code Lint Status (GitHub Actions),link={url-repo}/actions/workflows/ansible-lint.yml] image:https://img.shields.io/badge/slack-channel-tech?logo=slack[Slack Channel,link=https://redhat.enterprise.slack.com/archives/C06UNKD7813] image:https://img.shields.io/badge/miro-workspace-board?logo=miro[Miro Workspace,link=https://miro.com/app/board/uXjVKUIlyW8=/] image:https://img.shields.io/badge/JIRA-Board-Workspace?logo=slack[JIRA Board,link=https://issues.redhat.com/secure/RapidBoard.jspa] - -This repository is intended to contain ansible automation code. All documents are stored on https://github.com/showroom-project/showroom-code[Showroom Code] repository. - -The goal of this project is to build a Red Hat based environment suitable for a showroom project by an *enterprise* ready approach an opinionated Red Hat infrastructure that implements several Standard Operating Environments for Red Hat Enterprise Linux using Red Hat Management tools (Red Hat Infrastructure Standard Adoption Model). - -The Red Hat Infrastructure Standard (*RH-IS*)footnote:disclaimer[https://github.com/redhat-cop/rhis-builder[RHIS Builder Repository]] is a framework for using integrated Red Hat technologies to build, manage, automate, optimize, and maintain Red Hat Enterprise Linux at scale in a hybrid multi-cloud. -One of the fundamental principles of the *RH-ISAM* is to strive towards “*_everything as code_*”. The goal is repeatability, consistency, and stability and being modular. - -== Advantages of implementing the Red Hat Infrastructure Standard - -The Red Hat Infrastructure Standard is an opinionated framework for the deployment, configuration, and use of: - -* Red Hat Enterprise Linux -* Red Hat Identity Management -* Red Hat Satellite -* Red Hat Ansible Automation Platform -* Red Hat Build of Keycloak - -It leverages the Red Hat Hybrid Cloud Console to deploy, patch, maintain, secure, automate and ensure compliance of the Red Hat Enterprise Linux systems across a Hybrid Multi-cloud environment. - -GitOps practices are used in the process to define the desired states and conduct tests on management infrastructure and managed systems through an infrastructure-as-code pipeline. - -There are also external tools used to to simulate integration points such as - -* Self hosted GitHub Runner -* RootCA based on OpenSSL - -== where to start -Current https://github.com/showroom-project/showroom-code[showroom-code] consumes https://github.com/showroom-project/showroom-inventory[showroom-inventory] repository for the credentials and configurable variables. Duplicate `showroom-inventory` repository as your own inventory to use if you plan to deploy environment on your own and update definitions based on your own. - -First you can initialize your local environment by running link:playbooks/landscape_init.yml[`landscape_init.yml`]. This playbook will create an SSH Key pair and configuration for the generic SSH that enables access using Bastion. SSH public key will encrypted and pushed to the inventory repository. - -```bash -ansible-playbook -i showroom-inventory/inventory.yml showroom-code/playbooks/landscape_init.yml --ask-vault-pass -e init_environment_set=true -``` - -link:playbooks/landscape_site.yml[`landscape_site.yml`] is the main Ansible playbook to trigger everything from scratch for a Big Bang. - -```bash -ansible-playbook -i showroom-inventory/inventory.yml showroom-code/playbooks/landscape_site.yml --ask-vault-pass -``` - -Refer to link:docs/where_to_start.md[where to start documentation] for more information. diff --git a/README.md b/README.md index dbfda4b..f336a8d 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # RHIS-code -[![Ansible Lint](https://github.com/redhat-cop/rhis-code/actions/workflows/ansible-lint.yml/badge.svg)](https://github.com/redhat-cop/rhis-code/actions/workflows/ansible-lint.yml) [![Slack Channel](https://img.shields.io/badge/slack-channel-tech?logo=slack)](https://redhat.enterprise.slack.com/archives/C07TAP5PJ8K) +[![Ansible Lint](https://github.com/redhat-cop/rhis-code/actions/workflows/ansible-lint.yml/badge.svg)](https://github.com/redhat-cop/rhis-code/actions/workflows/ansible-lint-github-hosted.yml) [![Slack Channel](https://img.shields.io/badge/slack-channel-tech?logo=slack)](https://redhat.enterprise.slack.com/archives/C07TAP5PJ8K) This repository is intended to contain ansible automation code. All documents are stored on [docs](https://github.com/redhat-cop/rhis-code/docs). diff --git a/docs/ansible_practices.md b/docs/ansible_practices.md index b62d7e0..22ce127 100644 --- a/docs/ansible_practices.md +++ b/docs/ansible_practices.md @@ -46,7 +46,7 @@ Controller. The named should be include a prefix named `landscape_`. Use cases are high level collections of tasks, grouped around a specific type of usage - base operating system configuration, a particular server -deployment etc. Use cases are mapped as epics in the Jira. These epics +deployment etc. Use cases are mapped as epics. These epics contain user stories, tasks and bugs for specific features. These kind of playbooks should start with a prefix named `type_` which can be easily used on Ansible Automation Controller. Each type is then made of @@ -57,7 +57,7 @@ by the same type can be re-used, written only once. Depending on the complexity and distinct requirements, a use case might contain one or more features. Features are generally mapped to user -stories in a particular epic in Jira. It is preferred to create a simple +stories in a particular epic. It is preferred to create a simple playbook named with a prefix named `function_` for a particular role, mostly to be used as a ad-hoc script. diff --git a/docs/branch_standards.md b/docs/branch_standards.md index bcd11a7..53e9c28 100644 --- a/docs/branch_standards.md +++ b/docs/branch_standards.md @@ -14,7 +14,7 @@ contains two repositories; parameters for infrastructure and client groups, as well as global parameters -## Branch Naming Convention +##t - Feature Branches: feature-<Jira ticket number> diff --git a/docs/general_guidelines.md b/docs/general_guidelines.md index f19748a..bc0ef52 100644 --- a/docs/general_guidelines.md +++ b/docs/general_guidelines.md @@ -1,4 +1,4 @@ -# Azure cost estimation +# General Guidelines This document explains general guidelines for the project to work together. We all have agreed to work with Agile methodology and also @@ -7,13 +7,6 @@ part for building open framework between people in the project. ![Social Contract](./images/social_contract.jpg){ align=centre } -# User Stories - -We use internal JIRA to follow-up user stories, tasks, epics in the -project with agile approach. See -[JIRA](https://issues.redhat.com/secure/RapidBoard.jspa?rapidView=19625&projectKey=SHWRM&view=planning&issueLimit=100) -for the user stories and planning. - ## Definition of Ready ### Independent @@ -58,51 +51,14 @@ needs. These allow your team to evaluate whether the task is complete. 3. All issues solved within Merge request Review. -4. Merge requests points jira tickets. +4. All pipelines passed successfully. -5. All pipelines passed successfully. - -6. All Ansible code written idempotent allows same results when +5. All Ansible code written idempotent allows same results when executed more than once. -7. Test steps clearly described and proof attached. - -8. Documented clearly. - -## Backlog Guidelines - -1. All "STORIES" and "TASKS" are associated with an "EPIC" type issue - that logically represents all that needs to be down under a specific - context. - -2. "STORY" type issues shall be used to represent direct value to the - customer. As such the persona of such issue is always the customer. - -3. "TASK" type issues shall be used to represent either admin-like - tasks or technical tasks that do not represent direct value to the - customer. - -4. "SUB-TASK" type issues shall be used break down stories or tasks. Do - keep in mind they do not appear directly in the backlog. Use them as - a way to organize the issues you own. - -5. The pre-fix \[P\] present on the name of an issue in JIRA, means - that the issue is "Prepared" for refinement and can thus be reviewed - by the team. - -6. The pre-fix \[R\] present on the name of an issue in JIRA, means - that the issue is "Refined/Ready" to be taken into a sprint. - -7. Any member of the Core Implementation team can and is encouraged to - add any issues that they feel relevant to the backlog for future - refinement. - -8. Backlog Items will be estimated by complexity with the usage of the - Fibonacci sequence. +6. Test steps clearly described and proof attached. -9. Prioritization of the backlog is of the sole responsibility of the - acting PO (José Costa) and the backlog should be prioritized as part - of the refinement and planing events. +7. Documented clearly. # Git Cheat Sheet diff --git a/docs/onboarding.md b/docs/onboarding.md index 8b2a0b7..cde53ac 100644 --- a/docs/onboarding.md +++ b/docs/onboarding.md @@ -13,23 +13,6 @@ new members with the necessary support for their tasks. By following this onboarding guide, new team members will be well-prepared to contribute to the project’s success from the outset. -## Project Management - -A key component of our project management and follow-up process is the -use of an [RH internal JIRA](https://issues.redhat.com/projects/SHWRM) -system. This section of the document explains how JIRA is utilized to -track project progress, manage tasks, and ensure timely completion of -deliverables. Instructions on accessing and navigating the JIRA system, -along with best practices for updating tasks and communicating within -the platform, are provided to help new members quickly become proficient -in its use. By following this onboarding guide and effectively -leveraging JIRA, new team members will be well-prepared to contribute to -the project’s success from the outset. - -It is recommended to request a user story to be onboarded from other -team members through JIRA. Please ensure that all the necessary tools -are accessible from your side when JIRA user story completed. - ## Collaboration Slack is our main collaboration tool for real-time communication and @@ -38,7 +21,7 @@ communications, sharing updates, and quick problem-solving. Guidelines on joining relevant channels, best practices for messaging, and tips for effective use of Slack are included to help new members integrate seamlessly into the team’s communication flow. By following this -onboarding guide and effectively leveraging JIRA and Slack, new team +onboarding guide, new team members will be well-prepared to contribute to the project’s success from the outset. diff --git a/docs/slack_integration.md b/docs/slack_integration.md index f7861af..3a13679 100644 --- a/docs/slack_integration.md +++ b/docs/slack_integration.md @@ -24,20 +24,8 @@ integration, GitHub app should be installed on Slack from /invite @github # receive notifications only on pull request creation and workflow run - /github subscribe redhat-cop/rhis-code pulls workflows:{event:"pull_request" branch:"main"} + /github subscribe redhat-cop/rhis-code workflows:{event:“pull_request”,“push” branch:“main”,“devel”} /github unsubscribe redhat-cop/rhis-code issues commits releases deployments - /github subscribe redhat-cop/rhis-inventory pulls workflows:{event:"pull_request" branch:"main"} + /github subscribe redhat-cop/rhis-inventory workflows:{event:“pull_request”,“push” branch:“main”,“devel”} /github unsubscribe redhat-cop/rhis-inventory issues commits releases deployments - -## Jira Integration - -In-house developed Slack integration called [Red Hat Jira -Connector](https://source.redhat.com/personal_blogs/get_a_dm_in_slack_when_youre_mentioned_on_a_jira_issue) -allows Jira to send notifications on certain actions. You can customize -these notifications by navigating to Project Settings and then Slack -Integartion tab. We have limited these actions with only the followings: -Issue Created, Issue Resolved, Issue Closed, Issue Reopened, Issue -Moved, In Progress, Closed New Refinement. - -![Jira-Slack Integration](./images/jira_slack_integration.png)