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

Add docs about automatically using git ssh urls for pushing #6142

Merged
merged 1 commit into from
Jan 29, 2025

Conversation

perlpunk
Copy link
Contributor

@perlpunk perlpunk commented Jan 29, 2025

Issue: https://progress.opensuse.org/issues/174592

I will add a link to this documentation to the needle admin error message in a followup PR.
This will take a bit more time because we don't have low level unit tests for needle admin yet. (edit: actually we have, but I will do a followup PR)

Copy link

github-actions bot commented Jan 29, 2025

Great PR! Please pay attention to the following items before merging:

Files matching docs/*.asciidoc:

  • Consider generating documentation locally to verify it is rendered correctly using tools/generate-docs

This is an automatically generated QA checklist based on modified files.

@perlpunk
Copy link
Contributor Author

perlpunk commented Jan 29, 2025

  • Consider generating documentation locally to verify it is rendered correctly using tools/generate-docs
% tools/generate-docs
asciidoc not found in PATH.
Fallback to Rubygem's Asciidoc
tools/generate-docs: line 18: bundle: command not found

What do I need to do here? I remember this was running in a container in the past, but it was changed. Not sure what I am missing.

@perlpunk
Copy link
Contributor Author

perlpunk commented Jan 29, 2025

I also tried the suggestion from docs/Contributing.asciidoc

% podman run --rm -v OPENQA_LOCAL_CODE:/opt/openqa openqa_devel:latest make generate-docs
✔ registry.opensuse.org/openqa_devel:latest
Trying to pull registry.opensuse.org/openqa_devel:latest...
Error: initializing source docker://registry.opensuse.org/openqa_devel:latest: reading manifest latest in registry.opensuse.org/openqa_devel: name unknown

and

% podman run --rm -v OPENQA_LOCAL_CODE:/opt/openqa registry.opensuse.org/devel/openqa/containers/opensuse/openqa_devel:latest make generate-docs
make: *** No rule to make target 'generate-docs'.  Stop.

I will create a ticket about improving the instructions. Meanwhile, the change is hopefully simple enough that I don't need to check he HTML for this one?

@okurz
Copy link
Member

okurz commented Jan 29, 2025

@josegomezr can you remind us why your change helps here? :)

@perlpunk
Copy link
Contributor Author

ok, got it working:

podman run --rm -v $PWD:/opt/openqa registry.opensuse.org/devel/openqa/containers/opensuse/openqa_devel:latest make generate-docs

@mergify mergify bot merged commit 7958a99 into os-autoinst:master Jan 29, 2025
46 checks passed
@perlpunk perlpunk deleted the docs-git-push branch January 29, 2025 15:15
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.

3 participants