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

Improvement of build workflow #68

Merged
merged 9 commits into from
Oct 9, 2020

Conversation

Galileo-Galilei
Copy link
Owner

@Galileo-Galilei Galileo-Galilei commented Sep 21, 2020

  • Add a template for bug report
  • Add a template for feature request
  • Add a template for pull request
  • Improve test workflow:
    • rename dev in test
    • run tests on windows and macos
    • upload coverage report to Codecov
  • Create a manual workflow to create a release candidate:
    • bump version automatically
    • update CHANGELOG according to 'Keep a changelog' principles
    • create branch and PR on master automatically
  • Create a 'publish' workflow on merge on master:
    • create release
    • create tag
    • create PyPI release
    • merge back to develop
  • Update README:
    • Add badges for readibility
    • Add credits to maintainers
    • Fix command for latest installation with pip
  • Update CONTRIBUTING.md to explain the workflow for the release process
  • Eventually add the markdown linter suggested by @kaemo (for linting in the test workflow? it may be worth it to add it to the precommit hook too) -> I had issues on the pre-commit on windows and it seems known and not fixed. Since we have windows users, I think we should let it go for now. Are you ok with this @kaemo?
  • Update the CHANGELOG

@codecov-commenter
Copy link

codecov-commenter commented Sep 21, 2020

Codecov Report

❗ No coverage uploaded for pull request base (develop@94bae3d). Click here to learn what that means.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##             develop      #68   +/-   ##
==========================================
  Coverage           ?   96.68%           
==========================================
  Files              ?       32           
  Lines              ?     1177           
  Branches           ?        0           
==========================================
  Hits               ?     1138           
  Misses             ?       39           
  Partials           ?        0           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 94bae3d...fea80b0. Read the comment docs.

@Galileo-Galilei Galileo-Galilei marked this pull request as draft September 21, 2020 21:18
@Galileo-Galilei Galileo-Galilei force-pushed the feature/workflow-improvements branch 2 times, most recently from a0f81c9 to e652255 Compare September 21, 2020 21:48
@turn1a
Copy link
Contributor

turn1a commented Sep 23, 2020

@Galileo-Galilei there's a great Markdown linter you might be interested in: https://github.com/DavidAnson/markdownlint

@Galileo-Galilei Galileo-Galilei force-pushed the feature/workflow-improvements branch 4 times, most recently from 9464223 to fea80b0 Compare October 1, 2020 21:04
@Galileo-Galilei Galileo-Galilei self-assigned this Oct 1, 2020
@Galileo-Galilei Galileo-Galilei marked this pull request as ready for review October 1, 2020 21:08
@Galileo-Galilei Galileo-Galilei linked an issue Oct 1, 2020 that may be closed by this pull request
6 tasks
@turn1a
Copy link
Contributor

turn1a commented Oct 5, 2020

Starting the review process.

Copy link
Contributor

@turn1a turn1a left a comment

Choose a reason for hiding this comment

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

Only minor comments. Amazing work with this one!

.github/ISSUE_TEMPLATE/bug_report.md Show resolved Hide resolved
.github/PULL_REQUEST_TEMPLATE.md Outdated Show resolved Hide resolved
.github/PULL_REQUEST_TEMPLATE.md Outdated Show resolved Hide resolved
.github/workflows/prepare-release.yml Show resolved Hide resolved
.github/workflows/prepare-release.yml Outdated Show resolved Hide resolved
.github/workflows/publish.yml Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
- rename dev in test
- run tests on windows and macos
- upload coverage report to Codecov
- update version
- CHANGELOG
- create branch and PR
- create release
- create tag
- create PyPI release
- merge back to develop
- Add badges for readibility
- Add credits to maintainers
- Fix command for latest installation with pip
@Galileo-Galilei Galileo-Galilei force-pushed the feature/workflow-improvements branch from fea80b0 to c917197 Compare October 6, 2020 22:33
@Galileo-Galilei Galileo-Galilei requested a review from turn1a October 6, 2020 22:33
@Galileo-Galilei
Copy link
Owner Author

When you confirm you are ok now, I'll rebase it locally.

@codecov-io
Copy link

codecov-io commented Oct 6, 2020

Codecov Report

❗ No coverage uploaded for pull request base (develop@94bae3d). Click here to learn what that means.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##             develop      #68   +/-   ##
==========================================
  Coverage           ?   96.71%           
==========================================
  Files              ?       32           
  Lines              ?     1186           
  Branches           ?        0           
==========================================
  Hits               ?     1147           
  Misses             ?       39           
  Partials           ?        0           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 94bae3d...c917197. Read the comment docs.

@Galileo-Galilei Galileo-Galilei merged commit 242c71d into develop Oct 9, 2020
@Galileo-Galilei Galileo-Galilei deleted the feature/workflow-improvements branch October 9, 2020 21:24
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.

Improve development and release workflow
4 participants