🚧Add notes about Ubuntu to README
Closed this issue · 0 comments
CalvinWilkinson commented
Complete The Item Below
- I have updated the title without removing the 🚧 emoji.
Description
Update the README.md
file by replacing the Quick Note section. This text is about notifying the user that the action must be used in a job that runs on Ubuntu, not Windows.
Markdown to add:
<div align="center"><h3 style="font-weight:bold">⚠️Quick Note⚠️</h3></div>
This GitHub action is built using C#/NET and runs in a docker container. If the job step for running this action is contained in a job that runs on **Windows**, you will need to move the step to a job that runs on **Ubuntu**. You can split up your jobs to fulfill `runs-on` requirements of the GitHub action. This can be accomplished by moving the step into it's own job. You can then route the action step outputs to the job outputs and use them throughout the rest of your workflow. For more information, refer to the Github documentation links below:
For more info on step and job outputs, refer to the GitHub documentation links below:
- [Defining outputs for jobs](https://docs.github.com/en/actions/using-jobs/defining-outputs-for-jobs)
- [Setting a step action output parameter](https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#setting-an-output-parameter)
Acceptance Criteria
- README file updated
ToDo Items
- Change type labels added to this issue. Refer to the Change Type Labels section below.
- Priority label added to this issue. Refer to the Priority Type Labels section below.
- Issue linked to the correct project (if required).
- Issue linked to the correct milestone (if required).
- Draft pull request created and linked to this issue (only required with code changes).
Issue Dependencies
No response
Related Work
No response
Additional Information:
Change Type Labels
Change Type | Label |
---|---|
Bug Fixes |
🐛bug
|
Breaking Changes | https://github.com/KinsonDigital/VersionMiner/labels/%F0%9F%A7%A8breaking%20changes |
New Feature | https://github.com/KinsonDigital/VersionMiner/labels/%E2%9C%A8new%20feature |
Workflow Changes | https://github.com/KinsonDigital/VersionMiner/labels/workflow |
Code Doc Changes | https://github.com/KinsonDigital/VersionMiner/labels/%F0%9F%93%91documentation%2Fcode |
Product Doc Changes | https://github.com/KinsonDigital/VersionMiner/labels/%F0%9F%93%9Ddocumentation%2Fproduct |
Priority Type Labels
Priority Type | Label |
---|---|
Low Priority | https://github.com/KinsonDigital/VersionMiner/labels/low%20priority |
Medium Priority | https://github.com/KinsonDigital/VersionMiner/labels/medium%20priority |
High Priority | https://github.com/KinsonDigital/VersionMiner/labels/high%20priority |
Code of Conduct
- I agree to follow this project's Code of Conduct.