diff --git a/.github/workflows/init.yml b/.github/workflows/init.yml index 67f9724..f74ec4f 100644 --- a/.github/workflows/init.yml +++ b/.github/workflows/init.yml @@ -63,6 +63,7 @@ jobs: rm -f .github/workflows/build.yml rm -f .github/workflows/init.yml rm -f .github/workflows/publish.yml + rm -f .github/workflows/sync-docs-to-confluence.yml rm -rf .husky rm -rf .vscode rm -rf action diff --git a/CHANGELOG.md b/CHANGELOG.md index 5abc023..da80065 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -11,6 +11,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 #### Deprecated #### Removed +## [2.0.1] - 2025-04-10 + +### Fixed + +* fix: sync-to-confluence workflow file was not being deleted when running the initialization workflow. + +### Added + +* docs: Add notice about configuring the repository to allow github actions to open PRs before running the initialization workflow. + ## [2.0.0] - 2025-04-09 ### Changed diff --git a/README.md b/README.md index a758f39..d86c5cd 100644 --- a/README.md +++ b/README.md @@ -46,6 +46,8 @@ This scaffold is able to create projects with the following licenses: You can initialize a new open source project by creating a new repository from this template. Follow these steps: 1. __Create a new repository__: Click on the "Use this template" button in Github when creating a new repository, and select this template. + * __Important__: Make sure to select the "Allow GitHub Actions to create and approve pull requests" option when creating the repository. This is required for the "Initialize repository" workflow to work properly. Go to "Settings" > "Actions" > "General" and select the option. + ![Allow GitHub Actions to create and approve pull requests](./docs/assets/allow-github-actions.png) 2. __Run the "Initialize repository" workflow__: After creating the repository, go to the "Actions" tab and run the "Initialize repository" workflow. Enter the required [inputs](#inputs) and run the workflow. This will open a PR creating the initial files for your project, and removing the files from this template that are not needed in your project. ![Initialize repository workflow](./docs/assets/init-workflow.png) 3. __Rename the `.github-draft` folder__: The PR creates a `.github-draft` branch that needs to be renamed to `.github` manually before merging it. Follow the instructions in the PR description to rename the folder and push the changes. _(This is because creating workflow files from an action requires special permissions, and the process of granting them would be more complex than simply renaming the folder)._ diff --git a/docs/assets/allow-github-actions.png b/docs/assets/allow-github-actions.png new file mode 100644 index 0000000..a44f7af Binary files /dev/null and b/docs/assets/allow-github-actions.png differ diff --git a/package.json b/package.json index e9bbe15..067ae02 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@telefonica/opensource-scaffold", - "version": "2.0.0", + "version": "2.0.1", "type": "module", "description": "Scaffolding for open source projects. A CLI tool to create open source repositories with standard tools and resources", "packageManager": "pnpm@9.4.0",