Skip to content

add a update.manual: key to indicate a package should be manually u… #371

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

Merged
merged 1 commit into from
Apr 3, 2023
Merged

add a update.manual: key to indicate a package should be manually u… #371

Show file tree
Hide file tree
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
3 changes: 2 additions & 1 deletion docs/UPDATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ package:

update:
enabled: true # provide a flag to easily prevent a package from receiving auto update PRs
manual: true # indicates that this package should be manually updated, usually taking care over special version numbers which can be hard to automate
shared: false # indicate that an update to this package requires an epoch bump of downstream dependencies, e.g. golang, java
release-monitor:
identifier: 38 # Mandatory, ID number for release monitor
Expand All @@ -42,11 +43,11 @@ package:

update:
enabled: true # provide a flag to easily toggle a package from receiving auto update PRs
manual: true # indicates that this package should be manually updated, usually taking care over special version numbers which can be hard to automate
shared: false # indicate that an update to this package requires an epoch bump of downstream dependencies, e.g. golang, java
github: # alternative today is `release_monitor:`
identifier: sigstore/cosign # Mandatory, org/repo for github
strip-prefix: v # Optional, if the version obtained from the update service contains a prefix which needs to be stripped when updating the melange package
use-tag: true # Optional, override the default of using a GitHub release to identify related tag to fetch. Not all projects use GitHub releases but just use tags
tag-filter: foo # Optional, filter to apply when searching tags on a GitHub repository, some repos maintain a mixture of tags for different major versions for example
```

1 change: 1 addition & 0 deletions pkg/build/build.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -233,6 +233,7 @@ type AdvisoryContent struct {
// Update provides information used to describe how to keep the package up to date
type Update struct {
Enabled bool `yaml:"enabled"` // toggle if updates should occur
Manual bool `yaml:"manual"` // indicates that this package should be manually updated, usually taking care over special version numbers
Shared bool `yaml:"shared,omitempty"` // indicate that an update to this package requires an epoch bump of downstream dependencies, e.g. golang, java
VersionSeparator string `yaml:"version-separator,omitempty"` // override the version separator if it is nonstandard
ReleaseMonitor *ReleaseMonitor `yaml:"release-monitor,omitempty"`
Expand Down