Skip to content

chore(ci): fix typo in doc publishing workflow #1349

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

Merged

Conversation

dreamorosi
Copy link
Contributor

Description of your changes

This PR fixes an issue in the workflow that publishes the docs after a PR that changes files related to them has been merged. As described in #1348, the workflow had a typo that caused it to fail immediately on startup.

The PR corrects the typo and also removes some extra lines, as well as one of the paths that can trigger the workflow (examples/**). This path was present in the workflow because in the Python repository the code snippets are under that path. In this repo however the snippets that are placed in the docs are under the docs path, so the extra path is unnecessary.

Once merged the PR closes #1348.

How to verify this change

Check the next workflow run.

Related issues, RFCs

Issue number: #1348

Checklist

  • My changes meet the tenets criteria
  • I have performed a self-review of my own code
  • I have commented my code where necessary, particularly in areas that should be flagged with a TODO, or hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have made corresponding changes to the examples
  • My changes generate no new warnings
  • The code coverage hasn't decreased
  • I have added tests that prove my change is effective and works
  • New and existing unit tests pass locally and in Github Actions
  • Any dependent changes have been merged and published
  • The PR title follows the conventional commit semantics

Breaking change checklist

Is it a breaking change?: NO

  • I have documented the migration process
  • I have added, implemented necessary warnings (if it can live side by side)

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@dreamorosi dreamorosi self-assigned this Feb 28, 2023
@dreamorosi dreamorosi linked an issue Feb 28, 2023 that may be closed by this pull request
2 tasks
@pull-request-size pull-request-size bot added the size/XS PR between 0-9 LOC label Feb 28, 2023
@dreamorosi dreamorosi merged commit ca0bdb0 into main Feb 28, 2023
@github-actions github-actions bot added the internal PRs that introduce changes in governance, tech debt and chores (linting setup, baseline, etc.) label Feb 28, 2023
@dreamorosi dreamorosi deleted the 1348-maintenance-fix-typo-in-doc-publishing-workflow-1 branch February 28, 2023 18:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
internal PRs that introduce changes in governance, tech debt and chores (linting setup, baseline, etc.) size/XS PR between 0-9 LOC
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Maintenance: fix typo in doc publishing workflow
1 participant