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

Redundant version files in branches override the production versions #680

Closed
farshidtz opened this issue Jan 28, 2022 · 2 comments · Fixed by #698
Closed

Redundant version files in branches override the production versions #680

farshidtz opened this issue Jan 28, 2022 · 2 comments · Fixed by #698

Comments

@farshidtz
Copy link
Member

The CI overrides the versions.json file placed at gh-pages/versions.json with those sourced from any branch.

The versions.json file on the main branch is considered as the ground truth. All others are obsolete and misleading. I suggest removing this file from release branches other than the main and modifying the CI to ignore them if kept by mistake.

farshidtz added a commit to farshidtz/edgex-docs that referenced this issue Jan 28, 2022
farshidtz added a commit to farshidtz/edgex-docs that referenced this issue Jan 28, 2022
Signed-off-by: Farshid Tavakolizadeh <farshid.tavakolizadeh@canonical.com>
farshidtz added a commit to farshidtz/edgex-docs that referenced this issue Jan 28, 2022
Signed-off-by: Farshid Tavakolizadeh <farshid.tavakolizadeh@canonical.com>
farshidtz added a commit to farshidtz/edgex-docs that referenced this issue Jan 28, 2022
Signed-off-by: Farshid Tavakolizadeh <farshid.tavakolizadeh@canonical.com>
farshidtz added a commit to farshidtz/edgex-docs that referenced this issue Jan 28, 2022
Signed-off-by: Farshid Tavakolizadeh <farshid.tavakolizadeh@canonical.com>
farshidtz added a commit to farshidtz/edgex-docs that referenced this issue Jan 28, 2022
Signed-off-by: Farshid Tavakolizadeh <farshid.tavakolizadeh@canonical.com>
farshidtz added a commit to farshidtz/edgex-docs that referenced this issue Jan 28, 2022
Signed-off-by: Farshid Tavakolizadeh <farshid.tavakolizadeh@canonical.com>
@farshidtz
Copy link
Member Author

farshidtz commented Jan 31, 2022

There are actually two version files. One on the top level, and another under /docs directory. Looks like the one under /docs overrides the top-level version file in gh-pages branch. Same goes for the /docs/index.html and /docs/CNAME files.

farshidtz added a commit to farshidtz/edgex-docs that referenced this issue Feb 1, 2022
Signed-off-by: Farshid Tavakolizadeh <farshid.tavakolizadeh@canonical.com>
farshidtz added a commit to farshidtz/edgex-docs that referenced this issue Feb 2, 2022
Signed-off-by: Farshid Tavakolizadeh <farshid.tavakolizadeh@canonical.com>
farshidtz added a commit to farshidtz/edgex-docs that referenced this issue Feb 2, 2022
Signed-off-by: Farshid Tavakolizadeh <farshid.tavakolizadeh@canonical.com>
farshidtz added a commit to farshidtz/edgex-docs that referenced this issue Feb 2, 2022
Signed-off-by: Farshid Tavakolizadeh <farshid.tavakolizadeh@canonical.com>
@farshidtz
Copy link
Member Author

The files are removed from ireland and jakarta branches, so future changes to those branches will not break the versioning.

I could not fix this for hanoi and geneva because of unrelated CI failures, preventing this fix. Those branches are assumed frozen; see #684 (comment) and #683 (comment).

To prevent this from happening without any CI solution in place, the following files should be removed from future branches created from main:

/docs/index.html
/docs/CNAME
/docs/versions.json
/versions.json

@lenny-goodell lenny-goodell added this to New Issues in Core WG via automation Feb 15, 2022
Core WG automation moved this from New Issues to Done Feb 23, 2022
farshidtz added a commit that referenced this issue Aug 10, 2022
* fix: stay on page after version switch

Signed-off-by: Farshid Tavakolizadeh <farshid.tavakolizadeh@canonical.com>
(cherry picked from commit 6653e8f)

* fix: remove redundant versions, index, cname files (#680)

Signed-off-by: Farshid Tavakolizadeh <farshid.tavakolizadeh@canonical.com>
farshidtz added a commit that referenced this issue Aug 10, 2022
* fix: stay on page after version switch

Signed-off-by: Farshid Tavakolizadeh <farshid.tavakolizadeh@canonical.com>
(cherry picked from commit 6653e8f)

* fix: remove redundant versions, index, cname files (#680)

Signed-off-by: Farshid Tavakolizadeh <farshid.tavakolizadeh@canonical.com>
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 a pull request may close this issue.

1 participant