Fix #240, Add Instruction on How To Use Workflows in Contributing.md #241
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
skliper
approved these changes
Apr 14, 2021
skliper
added
the
CCB:Ready
|
Added status badge to OSAL's local unit test workflow and links to workflows. |
skliper
added
CCB:Approved
|
CCB:2021-04-14 - APPROVED |
astrogeco
suggested changes
Apr 29, 2021
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.
Move Code QL info to Code QL Analysis entry in the "our workflows" secton
There was a problem hiding this comment.
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.
Maybe add something about how these can be seen in their forks?
There was a problem hiding this comment.
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".
astrogeco
added
the
CCB:Approved
astrogeco
approved these changes
May 5, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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