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

Jump to bottom

[#147] Update readme #216

Merged
merged 2 commits into from
Nov 18, 2022
Merged

[#147] Update readme #216

merged 2 commits into from
Nov 18, 2022

Commits on Nov 18, 2022

  1. [Chore] Fix dockerhub tags 

    Problem: We have a pipeline step to tag docker images on dockerhub
whenever a new version is released:
https://github.com/serokell/xrefcheck/blob/7dd5c4c3c954a531b5cad89857f31b27245f0ef9/.buildkite/pipeline.yml#L51-L56

However, this doesn't seem to be working, dockerhub only contains the
`latest` tag: https://hub.docker.com/r/serokell/xrefcheck/tags

The problem *seems* to be that the CI step is only triggered when it
builds a branch with a name matching the regex `/^v[0-9]+.*/`. But we
never use that format for branch names, so it's never triggered.

Solution:
1. Change the CI step to trigger when it detects a tag with a version
   number
2. Enable the "Build tags" option in buildkite:
   https://buildkite.com/serokell/xrefcheck/settings/repository
    @dcastro
    dcastro committed Nov 18, 2022
    Configuration menu
    Copy the full SHA
    247f12a View commit details
    Browse the repository at this point in the history

  2. [#147] Improve readme 

    Improved the readme and fixed several problems:
* Mention support for GitLab - this is important and wasn't mentioned
  anywhere.
* Add a FAQ clarifying how xrefcheck behaves in some important
  situations.
* We don't need to get into a lot of detail about the syntax of the
  `xrefcheck: ignore` annotations, where they're allowed and where
  they're not. A general idea and a couple of examples are more than
  enough.
* Added the backlink `[↑](#xrefcheck)` where it was missing.
* Fixed inconsistent level headers: we we're using `###` where we should
  be using `##`
* `nix run` should now be `nix shell`
* Add a link to `tests/configs/github-config.yaml` which contains a list
  of all supported config options.
* Instead of mentioning GitHub Actions in the "usage" section and nix in
  a separate section, mention everything in the "usage" section.
* Fixed link to `stack2cabal`
* Fixed typos and rephrased some bits.
    @dcastro
    dcastro committed Nov 18, 2022
    Configuration menu
    Copy the full SHA
    2fd11bf View commit details
    Browse the repository at this point in the history