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.

Sign up for GitHub

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

Jump to bottom

Add some docs about GitHub actions and tags #68

Merged
merged 1 commit into from
Nov 13, 2024
Merged

Add some docs about GitHub actions and tags #68

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions doc/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -167,6 +167,20 @@ Depending on the kind of GitHub event, the run command will automatically:
- If it is a `push` with a tag version (e.g `v1.9.6` as configured with `[github]` section in the configuration) it will **perform a full build with publish**
- For an application, it will publish multiple cross-compiled packages to your release

> **NOTE about the publish process:**
>
> The publish process relies on a tag commit being pushed, and the GitHub action being run on that tag commit. If you have set up your GitHub action to only run on specific branches and not on tag pushes, the `dotnet-releaser` publish portion of the process will never run.
To fix this and still specify specific branches to run your action on, use something like this in your GitHub action:
>
> ```yml
> on:
> push:
> branches:
> - main # Used for stable releases
> - develop # Used for preview releases
> tags:
> - '*' # run on all tags being pushed
> ```
#### 1.2.2. Example of a GitHub CI Integration

An example of a setup with GitHub Actions:
Expand Down
Loading