Skip to content
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

Merged
merged 1 commit into from
May 5, 2021
Merged

Fix #240, Add Instruction on How To Use Workflows in Contributing.md #241

merged 1 commit into from
May 5, 2021

Conversation

ArielSAdamsNASA
Copy link
Contributor

Checklist (Please check before submitting)

Describe the contribution
Fixes #240

  • Added instructions on how to view errors from failed workflows
  • Added instructions on how to view workflow results in the Actions tab and in pull requests
  • Added a list of our workflows and the status of them
  • Added information on how to configure workflows and where to find them

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

@skliper skliper added the CCB:Ready Pull request is ready for discussion at the Configuration Control Board (CCB) label Apr 14, 2021
@ArielSAdamsNASA
Copy link
Contributor Author

ArielSAdamsNASA commented Apr 14, 2021

Added status badge to OSAL's local unit test workflow and links to workflows.

@skliper skliper added CCB:Approved Indicates code review and approval by community CCB CCB:2021-04-14 and removed CCB:Ready Pull request is ready for discussion at the Configuration Control Board (CCB) CCB:Approved Indicates code review and approval by community CCB labels Apr 14, 2021
@skliper
Copy link
Contributor

skliper commented Apr 14, 2021

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).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fix broken link syntax

Copy link
Contributor

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

Copy link
Contributor Author

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
Copy link
Contributor

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?

Copy link
Contributor Author

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".

CONTRIBUTING.md Outdated Show resolved Hide resolved
@astrogeco astrogeco added the CCB:Approved Indicates code review and approval by community CCB label May 5, 2021
@astrogeco astrogeco changed the base branch from main to integration-candidate May 5, 2021 18:45
@astrogeco astrogeco merged commit be3ae5b into nasa:integration-candidate May 5, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CCB:Approved Indicates code review and approval by community CCB docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add Instructions on How to Use Workflows in Contributing.md
4 participants