Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/workflows/init.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
10 changes: 10 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)._
Expand Down
Binary file added docs/assets/allow-github-actions.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -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",
Expand Down