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

Making sure that the example make publish-component-containers highli… #355

Closed
wants to merge 1 commit into from
Closed

Making sure that the example make publish-component-containers highli… #355

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
2 changes: 1 addition & 1 deletion docs/getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@ cluster, but make sure that you replace the URL with the registry URL that you
are using, if you are using something else:

```bash
make publish-component-containers CONTAINER_REPO=localhost:5000/ocurity/dracon
make publish-component-containers CONTAINER_REPO=localhost:5000/ocurity/dracon DRACON_VERSION=0.39.0
Copy link
Contributor

Choose a reason for hiding this comment

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

this means that we need to update the docs with every release, extra manual effort that i'm not super excited about.

doesn't this default to an automatically-calculated version?

Copy link
Contributor

Choose a reason for hiding this comment

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

@ptzianos added something similar here: https://github.com/ocurity/dracon-saas/pull/616/files#diff-76ed074a9305c04054cdebb9e9aad2d818052b07091de1f20cad0bbac34ffb52
The makefile refers to the latest version, so the specific version is not included in the readme

Copy link
Contributor

Choose a reason for hiding this comment

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

I would say that it would be a good idea to document the semantics of this. if you supply the DRACON_VERSION, then all components will be tagged as that DRACON_VERSION and if a version like that already exists and is published but you have done changes locally, you might have different behaviour than what you expect. If the environment variable is not supplied, one will be automatically calculated based on the latest tag which should make it clear that you are using something that is modified based on your local changes

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Makes sense, I can look into making sure that DRACON_VERSION is used based on latest and can remove the mentions of a specific version from the getting started docs. Right now we need to use DRACON_VERSION=XXXX in a few spots

```

*\*Notice that the repo we are using is slightly different from the
Expand Down