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

bug: building docs for tags is broken #2502

Closed
ncdc opened this issue Dec 15, 2022 · 0 comments · Fixed by #2503 or #2673
Closed

bug: building docs for tags is broken #2502

ncdc opened this issue Dec 15, 2022 · 0 comments · Fixed by #2503 or #2673
Assignees
Labels
kind/bug Categorizes issue or PR as related to a bug. kind/documentation Categorizes issue or PR as related to documentation.

Comments

@ncdc
Copy link
Member

ncdc commented Dec 15, 2022

Describe the bug

Builidng docs for tags does not complete successfully

Steps To Reproduce

  1. git push a tag
  2. https://github.com/kcp-dev/kcp/actions/workflows/docs-gen-and-push.yaml fails

Expected Behaviour

Success

Additional Context

Need to add a mkdir -p

2022-12-13T17:15:18.9821869Z ##[group]Run cd kcp/docs
2022-12-13T17:15:18.9822103Z �[36;1mcd kcp/docs�[0m
2022-12-13T17:15:18.9822315Z �[36;1mcat <<EOF > temp.txt�[0m
2022-12-13T17:15:18.9822533Z �[36;1m#version-start�[0m
2022-12-13T17:15:18.9822749Z �[36;1marchived_version = true�[0m
2022-12-13T17:15:18.9822983Z �[36;1mversion = "refs/tags/v0.10.0"�[0m
2022-12-13T17:15:18.9823190Z �[36;1mEOF�[0m
2022-12-13T17:15:18.9823393Z �[36;1med config.toml<<EOF�[0m
2022-12-13T17:15:18.9823612Z �[36;1m/^#version-start�[0m
2022-12-13T17:15:18.9823825Z �[36;1m+,/^#version-end/-1d�[0m
2022-12-13T17:15:18.9824142Z �[36;1m-r !sed -n '/^#version-start/,/^#version-end/p' temp.txt | grep -v '^#'�[0m
2022-12-13T17:15:18.9824415Z �[36;1mw�[0m
2022-12-13T17:15:18.9824638Z �[36;1mq�[0m
2022-12-13T17:15:18.9824812Z �[36;1mEOF�[0m
2022-12-13T17:15:18.9825047Z �[36;1mmv content/en/main content/en/refs/tags/v0.10.0�[0m
2022-12-13T17:15:18.9825280Z �[36;1mhugo --minify�[0m
2022-12-13T17:15:18.9825524Z �[36;1mrsync -av public/refs/tags/v0.10.0 ../../docs�[0m
2022-12-13T17:15:18.9879540Z shell: /usr/bin/bash -e {0}
2022-12-13T17:15:18.9879774Z ##[endgroup]
2022-12-13T17:15:18.9933688Z ##[debug]/usr/bin/bash -e /home/runner/work/_temp/9efec89e-07c8-4241-893a-ef538cb90208.sh
2022-12-13T17:15:19.0495270Z 4134
2022-12-13T17:15:19.0496268Z #version-start
2022-12-13T17:15:19.0518683Z 54
2022-12-13T17:15:19.0519349Z 4146
2022-12-13T17:15:19.0533656Z mv: cannot move 'content/en/main' to 'content/en/refs/tags/v0.10.0': No such file or directory
2022-12-13T17:15:19.0548700Z ##[error]Process completed with exit code 1.
@ncdc ncdc added kind/bug Categorizes issue or PR as related to a bug. kind/documentation Categorizes issue or PR as related to documentation. labels Dec 15, 2022
@ncdc ncdc self-assigned this Dec 15, 2022
@ncdc ncdc added this to kcp Dec 15, 2022
@ncdc ncdc moved this to New in kcp Dec 15, 2022
Repository owner moved this from New to Done in kcp Dec 15, 2022
avinal added a commit to avinal/kcp that referenced this issue Jan 25, 2023
- fixes the issue where a wrong folder name causes the command to
exit, the expected action is renaming the folder rather than
moving, fixes kcp-dev#2502
- fixes directory names for older versions. the github.ref is
a variable with "refs/tags/$REF" structure, for releases $REF
is of "vMAJOR.MINOR.PATCH" format, the archived docs directory
must be named as version tag
- fixes push permissions for pushing to gh-pages brnach. the
github action by default cannot push to branches, fixes kcp-dev#2655
- changes some links to relative links. this will help test the
docs locally s well as a separate deployments

Signed-off-by: Avinal Kumar <avinal@redhat.com>
avinal added a commit to avinal/kcp that referenced this issue Jan 25, 2023
- fixes the issue where a wrong folder name causes the command to
exit, the expected action is renaming the folder rather than
moving, fixes kcp-dev#2502
- fixes directory names for older versions. the github.ref is
a variable with "refs/tags/$REF" structure, for releases $REF
is of "vMAJOR.MINOR.PATCH" format, the archived docs directory
must be named as version tag
- fixes push permissions for pushing to gh-pages brnach. the
github action by default cannot push to branches, fixes kcp-dev#2655
- changes some links to relative links. this will help test the
docs locally s well as a separate deployments

Signed-off-by: Avinal Kumar <avinal@redhat.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/bug Categorizes issue or PR as related to a bug. kind/documentation Categorizes issue or PR as related to documentation.
Projects
Status: Done
1 participant