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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

馃毀Add notes about Ubuntu to README #30

Closed
8 tasks done
CalvinWilkinson opened this issue Aug 18, 2022 · 0 comments 路 Fixed by #31
Closed
8 tasks done

馃毀Add notes about Ubuntu to README #30

CalvinWilkinson opened this issue Aug 18, 2022 · 0 comments 路 Fixed by #31
Assignees
Labels
馃摑documentation/product Product documentation external to source code. Doc website good first issue Good for newcomers high priority High Priority preview Done while in preview

Comments

@CalvinWilkinson
Copy link
Member

CalvinWilkinson commented Aug 18, 2022

Complete The Item Below

  • I have updated the title without removing the 馃毀 emoji.

Description

Update the README.md file by adding the following 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.
Insert the markdown in between the What is it? and Quick Example sections.

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)

Old section to replace:
image

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 Something isn't working
Breaking Changes 馃Жbreaking changes Feature/changes contains breaking changes
New Feature 鉁╪ew feature New feature that does not exist
Workflow Changes https://github.com/KinsonDigital/BranchValidator/labels/workflow
Code Doc Changes 馃搼documentation/code Code documentation changes in source code. XML code docs/comments
Product Doc Changes 馃摑documentation/product Product documentation external to source code. Doc website

Priority Type Labels

Priority Type Label
Low Priority low priority Low Priority
Medium Priority medium priority Medium Priority
High Priority high priority High Priority

Code of Conduct

  • I agree to follow this project's Code of Conduct.
@CalvinWilkinson CalvinWilkinson added good first issue Good for newcomers high priority High Priority preview Done while in preview 馃摑documentation/product Product documentation external to source code. Doc website labels Aug 18, 2022
@CalvinWilkinson CalvinWilkinson added this to the v1.0.0 milestone Aug 18, 2022
@kselena kselena linked a pull request Aug 19, 2022 that will close this issue
10 tasks
@CalvinWilkinson CalvinWilkinson modified the milestones: v1.0.0, v1.0.0-preview.3 Aug 23, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
馃摑documentation/product Product documentation external to source code. Doc website good first issue Good for newcomers high priority High Priority preview Done while in preview
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants