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

Updates the repo docs with the current release workflow #2438

Merged
merged 5 commits into from
Apr 27, 2022
Merged

Conversation

nickfloyd
Copy link
Contributor

This PR contains the following:

  • Updates the deployment doc with the latest information, workflow, and specifics around generating and publishing a release to nuget.org
  • Updates the contributing doc to include details on how to contribute using GitHub codespaces
  • Removes the ReleaseNotes static file that is no longer used to communicate release details (that information is stored in per release)

DEPLOYMENT.md Outdated Show resolved Hide resolved
DEPLOYMENT.md Outdated Show resolved Hide resolved
DEPLOYMENT.md Outdated Show resolved Hide resolved

When running the release notes generator on a mac if dotnet has not been added to the PATH or there is not alias defined in your dotfiles you'll need to execute the command as follows:

`dotnet run generate [BASE] [HEAD]`
Copy link
Member

Choose a reason for hiding this comment

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

Not sure where to slot it in, but the tool is looking for a OCTOKIT_OAUTHTOKEN environment variable that needs minimal scopes to interact with the GitHub API

Copy link
Contributor Author

@nickfloyd nickfloyd Apr 27, 2022

Choose a reason for hiding this comment

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

I'll add a comment under the "Troubleshooting" section.

nickfloyd and others added 4 commits April 27, 2022 14:29
Co-authored-by: Brendan Forster <github@brendanforster.com>
Co-authored-by: Brendan Forster <github@brendanforster.com>
Co-authored-by: Brendan Forster <github@brendanforster.com>
@nickfloyd nickfloyd merged commit c4e6fcd into main Apr 27, 2022
@nickfloyd nickfloyd deleted the doc-updates branch April 27, 2022 19:49
@nickfloyd
Copy link
Contributor Author

release_notes: Updates docs to reflect the current workflow for generating releases

@nickfloyd nickfloyd added Type: Documentation Improvements or additions to documentation and removed category: docs-and-samples labels Oct 27, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants