René's URL Explorer Experiment

{"@context":"https://schema.org","@type":"QAPage","mainEntity":{"@type":"Question","name":"Docs on releases","text":"\u003cp dir=\"auto\"\u003eAre there any docs on the release workflow? Seems like I need to bump the version on a \u003ccode class=\"notranslate\"\u003erelease/{version}\u003c/code\u003e branch but would be good to see exactly what's needed to create a release\u003c/p\u003e","upvoteCount":2,"answerCount":1,"acceptedAnswer":{"@type":"Answer","text":"\u003cp dir=\"auto\"\u003eHey, sorry about that will definitely add some. Works been a bit crazy lately but will start having some more time to focus on this in about a week or so, and definitely working on the template docs as soon as I can\u003c/p\u003e\n\u003cp dir=\"auto\"\u003eFor setting up a release the workflow is the following:\u003c/p\u003e\n\u003cdiv class=\"snippet-clipboard-content notranslate position-relative overflow-auto\" data-snippet-clipboard-copy-content=\"git checkout develop\n# Ensure you have no outstanding changes, the script will purposely fail if \u0026quot;git status --porcelain\u0026quot; doesn't pass\n\nnox -s setup-release -- {PATCH_TYPE}\n\n# PATCH_TYPE can be one of [\u0026quot;MAJOR\u0026quot;, \u0026quot;MINOR\u0026quot;, \u0026quot;PATCH\u0026quot;, \u0026quot;PRERELEASE\u0026quot;]\"\u003e\u003cpre lang=\"terminal\" class=\"notranslate\"\u003e\u003ccode class=\"notranslate\"\u003egit checkout develop\n# Ensure you have no outstanding changes, the script will purposely fail if \"git status --porcelain\" doesn't pass\n\nnox -s setup-release -- {PATCH_TYPE}\n\n# PATCH_TYPE can be one of [\"MAJOR\", \"MINOR\", \"PATCH\", \"PRERELEASE\"]\n\u003c/code\u003e\u003c/pre\u003e\u003c/div\u003e\n\u003cp dir=\"auto\"\u003eThis should leave you with \u003ccode class=\"notranslate\"\u003erelease/x.y.z\u003c/code\u003e checked out, committed, and ready to be pushed to remote if everything went as expected.\u003c/p\u003e\n\u003cp dir=\"auto\"\u003eFrom there the workflow would be:\u003c/p\u003e\n\u003cul dir=\"auto\"\u003e\n\u003cli\u003eCreate a PR from \u003ccode class=\"notranslate\"\u003erelease/x.y.z\u003c/code\u003e into \u003ccode class=\"notranslate\"\u003emain\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eShould automatically run a bunch of CI/CD checks\u003c/li\u003e\n\u003cli\u003eMerge \u003ccode class=\"notranslate\"\u003erelease/x.y.z\u003c/code\u003e into main through PR\u003c/li\u003e\n\u003cli\u003eFetch changes locally and update local \u003ccode class=\"notranslate\"\u003emain\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eMerge local \u003ccode class=\"notranslate\"\u003emain\u003c/code\u003e into local \u003ccode class=\"notranslate\"\u003edevelop\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003ePush local \u003ccode class=\"notranslate\"\u003edevelop\u003c/code\u003e to remote\u003c/li\u003e\n\u003cli\u003eMerge local develop into local features as needed\u003c/li\u003e\n\u003c/ul\u003e\n\u003cp dir=\"auto\"\u003eCan definitely vary from this workflow, and I doubt it should affect too much, but this is kinda what I've been doing for the time being.\u003c/p\u003e\n\u003cp dir=\"auto\"\u003eI've tried out using proper gitflow where you merge \u003ccode class=\"notranslate\"\u003erelease/x.y.z\u003c/code\u003e into main and develop individually, and then leave the histories separate, but I kept running into history reference problems and some weird CI/CD flow issues with tagging doing it that way\u003c/p\u003e","upvoteCount":1,"url":"https://github.com/robust-python/cookiecutter-robust-python/discussions/35#discussioncomment-14641989"}}}