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

fix(README): Correct configuration lines in link #153

Closed
wants to merge 3 commits into from

Conversation

kunzaatko
Copy link

  • Use the main and HEAD for the snippet in README for the configuration.
  • Added a note for developer, that if the configuration changes, he/she
    should update the README link line numbers

Reason: It can be quite counterintuitive to setup the configuration that
is not up to date such that something from the copied configuration is
already deprecated. It should also adhere to the new provider format,
so that users know what to use.

- Use the main and HEAD for the snippet in README for the configuration.
- Added a note for developer, that if the configuration changes, he/she
  should update the README link line numbers

Reason: It can be quite counterintuitive to setup the configuration that
is not up to date such that something from the copied configuration is
already deprecated. It should also adhere to the new `provider` format,
so that users know what to use.
@Robitx
Copy link
Owner

Robitx commented Jul 16, 2024

@kunzaatko yep, I've forgot to update the link, thanks for the reminder. 👍

The trouble is that the "markdown code reference snippet" doesn't work without a static commit hash (with main it just becomes a normal link) and the line numbers would still need update with every significant conf change.

This looks like a candidate for some CI function, which will keep the README reference updated.

@kunzaatko
Copy link
Author

Didn't know that... That is quite annoying, since you would usually want to update the documentation in the same commit as the changes to the config. I will try to look into the CI possibility. Right now, I will change it to the static link, right?

@Robitx
Copy link
Owner

Robitx commented Jul 16, 2024

I've updated the reference directly, we can keep this PR around if you want to look into the CI options for solving it.

@Robitx
Copy link
Owner

Robitx commented Jul 16, 2024

@Robitx
Copy link
Owner

Robitx commented Jul 23, 2024

@kunzaatko I haven't found existing solution for this, so created my own github action https://github.com/Robitx/snippet-permalink-updater-action

e87d1ec ✔️

@Robitx Robitx closed this Jul 23, 2024
@kunzaatko
Copy link
Author

Great work! Thank you!

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

Successfully merging this pull request may close these issues.

None yet

3 participants