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

Add instructions for maintaining repo #20

Open
Eeems opened this issue Jun 8, 2023 · 4 comments
Open

Add instructions for maintaining repo #20

Eeems opened this issue Jun 8, 2023 · 4 comments

Comments

@Eeems
Copy link
Member

Eeems commented Jun 8, 2023

It would be useful to have instructions for the expected workflow of this repo.

  • How to update an image
  • How to create a new version of images
  • How to add a new image
  • etc
@Eeems
Copy link
Member Author

Eeems commented Jun 8, 2023

What I've discovered so far:

  • v1.x and v2.x branches are where the work is actually done
  • PRs from forks fail to build until they've been merged. Use branches on this repo until this can be fixed, I guess.
  • Merging a PR will update the latest tag, but not create new tags
  • Creating a new GitHub release will create a new image tag as well

@Eeems
Copy link
Member Author

Eeems commented Jun 24, 2023

It looks like new images are published as a new package, but it's private by default and needs to be changed to public.

@Eeems
Copy link
Member Author

Eeems commented Jul 25, 2023

You will also need to update CHANGELOG.md in the main branch when a new release tag has been created.

@Eeems
Copy link
Member Author

Eeems commented Jul 25, 2023

Creating a new v#.x branch requires updating the readme in the main branch with the latest information.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant