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

461-reorganizes the next step files for citation and online documentation #506

Merged
merged 6 commits into from
Aug 22, 2024

Conversation

fdiblen
Copy link
Member

@fdiblen fdiblen commented Aug 21, 2024

Description

This PR reorganizes the next step files for citation and online documentation.

Related issues:

Instructions to review the pull request

Step-1: Generate a new package:

cd $(mktemp -d --tmpdir py-tmpl-XXXXXX)
copier copy --vcs-ref 461_next_steps https://github.com/nlesc/python-template next_steps 

Choose 'yes' for citation and online documentation questions.

Step-2: Create a local git repo to push to GitHub to trigger CI actions:

cd next_steps
git init
git add --all
git commit -m "First commit"
git remote add origin [email protected]:<you>/python-template-test.git
git push -u origin main -f
  • Both citation and online documentation workflows should be triggered automatically
  • Check if the following files are removed:
    • .github/workflows/next_steps_citation.yml
    • .github/workflows/next_steps_citation_issue.md
    • .github/workflows/next_steps_online_documentation.yml
    • .github/workflows/next_steps_online_documentation_issue.md
  • Check if issues for citation and online documentation are created

@fdiblen fdiblen changed the title 461- improve next steps workflows 461-reorganizes the next step files for citation and online documentation Aug 21, 2024
@fdiblen fdiblen marked this pull request as ready for review August 21, 2024 18:06
@lyashevska
Copy link
Member

thanks @fdiblen! Citation and online documentation workflows are created and triggered automatically. Clean up did not work for me, see here:
https://github.com/lyashevska/test-next-steps/actions/runs/10505936822/job/29104526448

@lyashevska lyashevska self-requested a review August 22, 2024 12:25
Copy link
Member

@lyashevska lyashevska left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you please check clean up step? Everything else works as expected.

@fdiblen fdiblen requested a review from lyashevska August 22, 2024 12:50
Copy link
Member

@lyashevska lyashevska left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Excellent, this works as expected.

@fdiblen fdiblen merged commit 6295366 into main Aug 22, 2024
15 checks passed
@fdiblen fdiblen deleted the 461_next_steps branch August 22, 2024 13:11
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.

2 participants