Code Monkey home page Code Monkey logo

Comments (4)

michealroberts avatar michealroberts commented on August 17, 2024 1

@lgrcia Exactly. I think we should follow the process of, on creating a merge request, we run the test and lint suite.

Applying a blocker on the tests passing before it can be merged. At first, the tests may seem trivial but when they fail ... it's really insightful to see how a small change actually can brake things in unexpected ways.

And then on tag and release, we could run the full lint, test, coverage, build and submit to pypi for release.

I think that way, everything should be covered. I'll look to set this up for twirl ASAP. :)

Certainly let me know if you would like a more formal RFC...

from prose.

lgrcia avatar lgrcia commented on August 17, 2024

@michealroberts, you mentioned this in our discussion, would you be willing to help with that? If you want to check the current status of the project we are actively working on lgrcia/[email protected] that aim to be better documented and with more systematic testings (#56)!

from prose.

michealroberts avatar michealroberts commented on August 17, 2024

@lgrcia Hey Lionel, thanks for the merges this morning :)

Exact. I'd like to add some github actions to this repo that can improve the flow of releases as well as provide automated release notes / change logs.

I propose the following automated release process:

  • When we're ready to release, we tag the master / main branch with a version, e.g., v3.0.0, or 3.0.0 (which ever style you prefer).
  • We then push that release tag to the master branch.
  • We then publish a new release via Github, which looks up this newly created tag using semantic versioning
  • This on publish hook can trigger the build process for publishing to pypi ...

So we have the publishing automated on the release hook being triggered. This is how I usually do this in most of my typescript projects which works really well, it's semi-automated in the sense that we are in control of when to tag and when to the release, e.g., we can revert a tagging if we're not happy etc.

from prose.

lgrcia avatar lgrcia commented on August 17, 2024

That seems great! I am happy to review a PR for that (I'll read some documentation to be able to contribute as well). I like the release pipeline of projects like exoplanet-dev/exoplanet. This is close to the structure you mention, right?

from prose.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.