-
Notifications
You must be signed in to change notification settings - Fork 225
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Fix #240, Add Instruction on How To Use Workflows in Contributing.md #241
Fix #240, Add Instruction on How To Use Workflows in Contributing.md #241
Conversation
Added status badge to OSAL's local unit test workflow and links to workflows. |
CCB:2021-04-14 - APPROVED |
CONTRIBUTING.md
Outdated
|
||
#### Configure Workflows | ||
|
||
1. Workflows are under [.github/workflows](https://github.com/nasa/cFS/tree/main/). CodeQL uses a .yml file and a configuration file under .github/codeql(https://github.com/nasa/cFS/tree/main/.github/codeql). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fix broken link syntax
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Move Code QL info to Code QL Analysis entry in the "our workflows" secton
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixed link and moved CodeQL information to the CodeQL Analysis section.
- Push code changes to the appropriate forked repository. | ||
- Go to the Actions tab and enable GitHub Actions Workflow. The CodeQL Analyis and Static Analysis will be triggered for all pushed code. | ||
- Review these workflows for any warnings or errors. | ||
- Once successful, create a pull request. | ||
|
||
### Using GitHub Actions Workflows |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe add something about how these can be seen in their forks?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixed.
All of our workflows will be available for forked repositories once enabled. To enable workflows, navigate to the Actions tab and click "I understand my workflows, go ahead and enable them".
Checklist (Please check before submitting)
Describe the contribution
Fixes #240
Expected behavior changes
Users should know how to use our workflows.
Additional context
Used Reference: https://docs.github.com/en/actions/quickstart
Used Example: https://github.com/TommyLin/focus-stacking/wiki/Github-Actions
Contributor Info - All information REQUIRED for consideration of pull request
Ariel Adams, ASRC Federal