{"id":29016192,"url":"https://github.com/fastai/fastrelease","last_synced_at":"2025-06-25T22:07:22.219Z","repository":{"id":39615760,"uuid":"293522421","full_name":"fastai/fastrelease","owner":"fastai","description":"DEPRECATED--all functionality moved to nbdev","archived":false,"fork":false,"pushed_at":"2022-08-03T04:12:34.000Z","size":1564,"stargazers_count":15,"open_issues_count":7,"forks_count":12,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-05-21T10:06:04.334Z","etag":null,"topics":["github","nbdev","python","release-automation","releases"],"latest_commit_sha":null,"homepage":"","language":"Jupyter Notebook","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/fastai.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-09-07T12:30:13.000Z","updated_at":"2024-01-04T16:50:05.000Z","dependencies_parsed_at":"2022-07-13T10:30:38.537Z","dependency_job_id":null,"html_url":"https://github.com/fastai/fastrelease","commit_stats":null,"previous_names":[],"tags_count":22,"template":false,"template_full_name":null,"purl":"pkg:github/fastai/fastrelease","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fastai%2Ffastrelease","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fastai%2Ffastrelease/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fastai%2Ffastrelease/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fastai%2Ffastrelease/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fastai","download_url":"https://codeload.github.com/fastai/fastrelease/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fastai%2Ffastrelease/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261368070,"owners_count":23147940,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["github","nbdev","python","release-automation","releases"],"created_at":"2025-06-25T22:07:20.169Z","updated_at":"2025-06-25T22:07:22.205Z","avatar_url":"https://github.com/fastai.png","language":"Jupyter Notebook","readme":"fastrelease\n================\n\n\u003c!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! --\u003e\n\n**NB: This project is now deprecated – its functionality has been moved\ninto [nbdev.release](https://nbdev.fast.ai).**\n\n[fastrelease](https://fastrelease.fast.ai/core.html#fastrelease)\nprovides two commands that you can run from your shell:\n\n-   `nbdev_changelog`: creates a CHANGELOG.md file from closed and\n    labeled GitHub issues\n-   `nbdev_tag_release`: tags and creates a release in GitHub for the\n    current version.\n\nBe sure to check out the full documentation at\n[fastrelease.fast.ai](https://fastrelease.fast.ai/). Here’s a brief\ndemonstration of how to use\n[fastrelease](https://fastrelease.fast.ai/core.html#fastrelease). This\ndemo first creates an issue using the [`gh`](https://cli.github.com/)\ncommand line tool, and then closes it using `git`; you can also use\nGitHub’s web interface for both of these tasks.\n\n\u003ca href=\"images/intro.svg\"\u003e\u003cimg src=\"images/intro.svg\" width=\"900px\" /\u003e\u003c/a\u003e\n\n## Install\n\n[fastrelease](https://fastrelease.fast.ai/core.html#fastrelease) has\nonly one small prerequisite (`fastcore`) and will run on Python 3.6 or\nlater. You can install from pip:\n\n`pip install fastrelease`\n\n…or conda:\n\n`conda install -c fastai fastrelease`\n\n## How to use\n\n### Set up\n\nFirst, create a `settings.ini` file with the following contents\n(replacing the values as described below):\n\n    [DEFAULT]\n    lib_name = fastrelease\n    user = fastai\n    version = 0.0.1\n\nSet `lib_name` to the name of GitHub repo, `user` to the owner of that\nrepo, and `version` to the version number of your library. (Note that if\nyou use [nbdev](https://nbdev.fast.ai) then you’ll already have this\ninformation, so you don’t need to do anything further to set it up.)\n\nYou’ll need to get a GitHub [personal access\ntoken](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token)\nif you haven’t already. To do so, [click\nhere](https://github.com/settings/tokens/new) and enter “fastrelease” in\nthe “Note” section, and click the `repo` checkbox.\n\nThen click “Generate Token” at the bottom of the screen, and copy the\ntoken (the long string of letters and numbers shown). You can easily do\nthat by clicking the little clipboard icon next to the token.\n\n\u003cimg alt=\"Copying your token\" width=\"743\" caption=\"Copying your token\" src=\"images/att_00001.png\"\u003e\n\nPaste that token into a file called `token` into the root of your repo.\nYou can run the following in your terminal (`cd` to the root of your\nrepo first) to create that file:\n\n    echo XXX \u003e token\n\nReplace *XXX* above with the token you copied. Also, ensure that this\nfile isn’t added to git, by running this in your terminal:\n\n    echo token \u003e\u003e .gitignore\n\n### Creating release notes\n\nNow you’re ready to create your release notes. These are created in a\nfile called `CHANGELOG.md`. Here’s an example of what it creates: [nbdev\nCHANGELOG](https://github.com/fastai/nbdev/blob/master/CHANGELOG.md).\n\nAll issues with the label **bug**, **enhancement**, or **breaking** that\nhave been closed in your repo since your last release will be added to\nthe top of this file. If you haven’t made any releases before, then all\nissues with those labels will be included.\n\nTherefore, before you create or update `CHANGELOG.md`, go to your GitHub\nissues page, remove `is:open` from the filter, and label any issues you\nwant included with one of the labels above. When you’ve done that, you\ncan create or update your release notes by running in your terminal:\n\n    fastrelease_changelog\n\nThe titles and bodies of each issue will be added. Open `CHANGELOG.md`\nin your editor and make any edits that you want, and then commit the\nfile to your repo (remember to `git add` it!)\n\n### Tagging a release\n\nYou should now tag a release. This will create a tag in GitHub with your\ncurrent version number in `settings.ini`, and will then make it into a\nrelease, using your latest release notes as the description of the\nrelease:\n\n    fastrelease_release\n\nAfter you run this, be sure to increment your version number in\n`settings.ini`. You can either edit it manually, or if you use nbdev it\ncan be done for you by running:\n\n    nbdev_bump_version\n\n### Doing both (creating release notes, and tagging a release)\n\nTo complete both of the steps above, run:\n\n    fastrelease\n\nSee the screencast above for a demonstration of this.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffastai%2Ffastrelease","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffastai%2Ffastrelease","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffastai%2Ffastrelease/lists"}