-
Notifications
You must be signed in to change notification settings - Fork 1.1k
New Module Checklist
Sergio del Amo edited this page Apr 11, 2024
·
9 revisions
- Use Project template to create a new repository.
- Prefix the repository with
micronaut-
. - Add the project to file sync without the
micronaut-
prefix. - Add the module to management repository. Ping @graeme or @sdelamo about it.
- Request a Sonar Cloud admin to add the new project, and disable Automatic Analysis. Ping @sdelamo about it.
- Set Long Lived Branches pattern to
\d+\.\d+\.x
- Add module to https://github.com/micronaut-projects/micronaut-docs-index/blob/main/modules.yml
Here are the steps followed when we created micronaut-session
https://docs.github.com/en/get-started/using-git/splitting-a-subfolder-out-into-a-new-repository
Step by step; (Replace micronaut-session
for your new module name, and session
as your sub-project of interest)
- Install
git-filter-repo
brew install git-filter-repo
- Clone the branch of core you're interested in extracting from
git clone https://github.com/micronaut-projects/micronaut-core.git -b 4.0.x micronaut-session
- go into the new directory
cd micronaut-session
- Filter the repo to remove anything non-session related
git filter-repo --path session/
- Rename the branch to master
git branch -m master
- Strip all the tags
git tag -d $(git tag -l)
- Strip all the branches
git branch | grep -v "master" | xargs git branch -D
- Create a new public project on GitHub under
micronaut-projects
calledmicronaut-session
- Add a remote pointing to this new repo
git remote add origin https://github.com/micronaut-projects/micronaut-session.git
- From a local recent clone of https://github.com/micronaut-projects/micronaut-project-template, copy all the files into the current folder.
- Fix them up with your project name, as per normal
- Push
git push origin master
You will need to copy docs from core/src
to your new repo.
Then follow the steps above