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

Update workflows to run on GitHub #328

Merged
merged 62 commits into from
Apr 25, 2023
Merged

Conversation

wbarnha
Copy link
Member

@wbarnha wbarnha commented Apr 16, 2023

What do these changes do?

Run CI/CD jobs on GitHub instead of legacy Travis.

Are there changes in behavior for the user?

We can start releasing updates again, soon 😄

Related issue number

Branching off #327

Checklist

  • I think the code is well written
  • Unit tests for the changes exist
  • Documentation reflects the changes
  • Add a new news fragment into the CHANGES folder
    • name it <issue_id>.<type> (e.g. 588.bugfix)
    • if you don't have an issue_id change it to the pr id after creating the PR
    • ensure type is one of the following:
      • .feature: Signifying a new feature.
      • .bugfix: Signifying a bug fix.
      • .doc: Signifying a documentation improvement.
      • .removal: Signifying a deprecation or removal of public API.
      • .misc: A ticket has been closed, but it is not of interest to users.
    • Make sure to use full sentences with correct case and punctuation, for example: Fix issue with non-ascii contents in doctest text files.

.github/workflows/default.yml Outdated Show resolved Hide resolved
PYTHON_LATEST: "3.11"

# For re-actors/checkout-python-sdist
sdist-artifact: python-package-distributions

jobs:
lint-flake8:
Copy link
Member

Choose a reason for hiding this comment

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

How about separating the linting jobs into a dedicated reusable workflow?

with:
fetch-depth: 2
fetch-depth: 0
Copy link
Member

Choose a reason for hiding this comment

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

Is this bit really needed for linting?

- run: python -Im pip install build
name: Install core libraries for build and install
- name: Build artifacts
run: python -Im build
Copy link
Member

Choose a reason for hiding this comment

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

Since the linting jobs currently don't depend on this one, maybe it's a good idea to run twine check --strict after this step. Alternatively, I'd put linting in a dedicated job.

@achimnol
Copy link
Member

@webknjaz Q. Should I add some if: conditions to the second job (Publish to GitHub Pages) in the docs.yml workflow, as it's reporting deployment failure due to missing permission of this branch? It seems that all future PR branches will have the same issue.

@achimnol
Copy link
Member

@webknjaz Q. Should I add some if: conditions to the second job (Publish to GitHub Pages) in the docs.yml workflow, as it's reporting deployment failure due to missing permission of this branch? It seems that all future PR branches will have the same issue.

We decided to migrate to .readthedocs.yml and remove docs.yml.

@achimnol
Copy link
Member

achimnol commented Apr 25, 2023

For follow-ups, see #352.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants