canonical / canonical/documentation-workflows

use stable versions instead of `main` branch for consistent checking result

Open
#6 4 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
5
Forks
15
PR merge metrics
No merged PRs in 30d

Description

It's great that we can benefit from new features by simply referencing this repository. Meanwhile, a concern about using the `main` branch is that frequent changes in the branch may cause variances in the test results in the doc repository. If the base pipeline changes or upgrades between two commits in the same PR, it might be hard to trace on the developer side.

A proposal is to introduce tags on a stable version so that in the workflow definition file, we can choose to use the latest stable version, and only upgrade the version when the next stable version is available.

```yaml
jobs:
documentation-checks:
uses: canonical/documentation-workflows/.github/workflows/documentation-checks.yml@main
```

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.