https://github.com/arup-group/actions-composite-oasys-jira-check
Common workflow to check jira key is referenced correctly in branches
https://github.com/arup-group/actions-composite-oasys-jira-check
Science Score: 26.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
○Academic publication links
-
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (7.8%) to scientific vocabulary
Repository
Common workflow to check jira key is referenced correctly in branches
Basic Info
- Host: GitHub
- Owner: arup-group
- License: mit
- Language: Python
- Default Branch: main
- Size: 45.9 KB
Statistics
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 3
- Releases: 2
Metadata Files
README.md
Usage
In both cases you will need the JIRA_PASSWORD secret to be set in the repository secrets. This is the password for the automation account.
Pull request workflow
To use this action from a PR workflow, add the following to your workflow file:
```yml on: pull_request:
jobs: check-jira: runs-on: ubuntu-22.04
steps:
- uses: arup-group/actions-composite-oasys-jira-check/branch@main
with:
valid-branch-names: task|test|bugfix|feature|hotfix|epic
jira-username: automation@arup.com
jira-password: ${{ secrets.JIRA_PASSWORD }}
branch_to_check: refs/heads/${{ github.event.pull_request.head.ref }}
# Optional. If not provided, pr title is not checked for JIRA key
# If provided, checks PR title is formatted as `JIRA-1234 | My PR title` or `JIRA-1234 : My PR title`
# where the whitespace before the delimiter is optional
pr_title: ${{ github.event.pull_request.title }}
```
Push to branch workflow
If you want to add this action to a workflow that runs on push to a branch, you can use the following:
```yml on: push:
jobs: check-jira: runs-on: ubuntu-22.04
steps:
- uses: arup-group/actions-composite-oasys-jira-check/branch@main
with:
valid-branch-names: task|test|bugfix|feature|hotfix|epic
jira-username: automation@arup.com
jira-password: ${{ secrets.JIRA_PASSWORD }}
```
Development
For local debug and development, you can run the python scripts directly.
Copy .env.example to .env and fill in the values.
Note:
This repo is public so other public Arup projects (GSA-Grasshopper) can use it.
Owner
- Name: Arup
- Login: arup-group
- Kind: organization
- Email: media@arup.com
- Website: https://www.arup.com/
- Repositories: 168
- Profile: https://github.com/arup-group
We Shape a Better World
GitHub Events
Total
- Delete event: 1
- Push event: 1
- Pull request review event: 2
- Pull request event: 2
- Create event: 1
Last Year
- Delete event: 1
- Push event: 1
- Pull request review event: 2
- Pull request event: 2
- Create event: 1
Issues and Pull Requests
Last synced: 11 months ago
All Time
- Total issues: 0
- Total pull requests: 11
- Average time to close issues: N/A
- Average time to close pull requests: 28 days
- Total issue authors: 0
- Total pull request authors: 2
- Average comments per issue: 0
- Average comments per pull request: 1.09
- Merged pull requests: 7
- Bot issues: 0
- Bot pull requests: 2
Past Year
- Issues: 0
- Pull requests: 10
- Average time to close issues: N/A
- Average time to close pull requests: about 18 hours
- Issue authors: 0
- Pull request authors: 2
- Average comments per issue: 0
- Average comments per pull request: 0.8
- Merged pull requests: 6
- Bot issues: 0
- Bot pull requests: 2
Top Authors
Issue Authors
Pull Request Authors
- renefritze (17)
- dependabot[bot] (3)
Top Labels
Issue Labels
Pull Request Labels
Dependencies
- ./branch * composite
- actions/checkout v3 composite
- actions/checkout v4 composite
- actions/setup-python v5 composite
- actions/cache v4 composite
- actions/checkout v4 composite
- actions/setup-python v5 composite
- actions/upload-artifact v4 composite
- pytest * development
- pytest-cov * development
- pytest-pycharm * development
- requests-mock * development
- certifi ==2024.6.2 development
- charset-normalizer ==3.3.2 development
- coverage ==7.5.3 development
- idna ==3.7 development
- iniconfig ==2.0.0 development
- packaging ==24.1 development
- pluggy ==1.5.0 development
- pytest ==8.2.2 development
- pytest-cov ==5.0.0 development
- pytest-pycharm ==0.7.0 development
- requests ==2.32.3 development
- requests-mock ==1.12.1 development
- urllib3 ==2.2.1 development
- python-dotenv *
- requests *
- certifi ==2024.6.2
- charset-normalizer ==3.3.2
- idna ==3.7
- python-dotenv ==1.0.1
- requests ==2.32.3
- urllib3 ==2.2.1