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

For simplicity, only define the recommended TagBot configuration in a single place? #204

Open
DilumAluthge opened this issue Jun 11, 2021 · 0 comments
Labels
documentation rewrite Will be done in the Julia rewrite of TagBot (see #55), but not before.

Comments

@DilumAluthge
Copy link
Member

Currently, the officially recommended TagBot configuration is located in two places:

  1. The "Setup" section of the README.md file
  2. The example.yml file

It's a little sub-optimal to have the same information duplicated in two different places. For example, if we make a change in one place, we have to remember to also change the other place; otherwise, the two will become out-of-sync.

When TagBot is re-written in Julia, perhaps we could re-organize it so that we only need to define the recommended TagBot configuration in a single place.

For example, in CompatHelper, we define the recommended TagBot configuration in a single place: https://github.com/JuliaRegistries/CompatHelper.jl/blob/master/.github/workflows/CompatHelper.yml

And then, when we generate the documentation, we automatically pull in the contents of the .github/workflows/CompatHelper.yml file using an @eval block, as such: https://github.com/JuliaRegistries/CompatHelper.jl/blob/master/docs/src/index.md

@DilumAluthge DilumAluthge added rewrite Will be done in the Julia rewrite of TagBot (see #55), but not before. documentation labels Jun 11, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation rewrite Will be done in the Julia rewrite of TagBot (see #55), but not before.
Projects
None yet
Development

No branches or pull requests

1 participant