dirfy 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e8e6bf9d28ac3108a8de6bc541c8c0e2b63fdd101bcf973bcbad6369d87b6dc5
-  data.tar.gz: 0e925d19a257eeb53d9ab97f826056cd0c063bd7ec44ef44242aea30dec3b24f
+  metadata.gz: 2280485e374e77646217758bb7ff581745d1027c716de33bbf180532c37099d5
+  data.tar.gz: 9ce1d4d53bb3bc4f1c6d4b39bbf0d9dca6a73f0c50ecd2a28a089af2301076fd
 SHA512:
-  metadata.gz: 7d51b837da07c76434ff5d81ecc91e497cbd1360bcc3de28eff299c95489d43d8a6d1fd95331f4b7d892ddb5e3ba861b2c553373d38c08a9ee174fccdbb4bff7
-  data.tar.gz: e6d08d7060cd432e3dd73b3b1c1a6a649406820c66b2149f50ac97d5c7bfe9e524e4e9f9aa256b95f7ff5ed034d9f9a1ac683510f4b3adc41bd3de3d57233200
+  metadata.gz: 57c73e9a491dd9ad6ca56cceb0e7d16bdcfc65524b93e331f4008eebea5d77a5d27e9775553cf354adeaa809e75c1a174133a5a4542ccc18a15a139b8af53af5
+  data.tar.gz: ef290b90b405d6151738c97bede4e2778c437394865ed42830849e3fb0d5b4ebbff7f287bcbeaf7ce198b0b05a95c9ec03e94a0b3dcac015a792d5629530c8c4

data/README.md

@@ -129,10 +129,122 @@ Happy scaffolding! 🚀
 
 ---
 
-## 📝 License
+## � Release Process
+
+This section documents the release process for maintainers.
+
+### Prerequisites
+
+- Push access to the repository
+- RubyGems account with push access to the `dirfy` gem
+- 2FA enabled on RubyGems account
+
+### Release Steps
+
+1. **Run tests and ensure clean state**
+   ```bash
+   bundle exec rake
+   git status  # should be clean
+   ```
+
+2. **Update version**
+   ```bash
+   # Edit lib/dirfy/version.rb
+   vim lib/dirfy/version.rb
+   ```
+
+3. **Commit version bump**
+   ```bash
+   git add lib/dirfy/version.rb Gemfile.lock
+   git commit -m "chore: bump version to vX.Y.Z"
+   ```
+
+4. **Create and push tag**
+   ```bash
+   git tag vX.Y.Z
+   git push origin main
+   git push origin vX.Y.Z
+   ```
+
+5. **Build and publish gem**
+   ```bash
+   rake build
+   gem push pkg/dirfy-X.Y.Z.gem
+   # Follow 2FA authentication flow
+   ```
+
+6. **Create GitHub release**
+   ```bash
+   gh release create vX.Y.Z pkg/dirfy-X.Y.Z.gem \
+     --title "vX.Y.Z" \
+     --notes "Release notes here"
+   ```
+
+### Automated Release (Helper Script)
+
+Use the provided release script for semi-automated releases:
+
+```bash
+./scripts/release.sh patch  # for patch version (0.0.X)
+./scripts/release.sh minor  # for minor version (0.X.0)  
+./scripts/release.sh major  # for major version (X.0.0)
+```
+
+### Troubleshooting
+
+- **2FA Authentication**: RubyGems requires 2FA. Use WebAuthn or `--otp` flag
+- **Workflow scope**: GitHub token needs `workflow` scope to modify Actions
+- **Permission denied**: Ensure you have push access to both repo and RubyGems
+
+---
+
+## �📝 License
 
 MIT © [Ahmed Elhady](https://github.com/ahmedmelhady7)
 
 ---
 
-> Built with ❤️ to make AI-generated project scaffolding a breeze.
+> Built with ❤️ to make AI-generated project scaffolding a breeze.
+
+---
+
+## Release steps
+
+This project supports both local and GitHub Actions-based releases. The workflow `/.github/workflows/release.yml` will publish a built gem when a `vX.Y.Z` tag is pushed, but the runner needs a valid `RUBYGEMS_API_KEY` secret and the repository maintainer must ensure the CI token can run workflow jobs that modify releases.
+
+Local release (recommended when you need to provide 2FA interactively):
+
+1. Bump the version in `lib/dirfy/version.rb` (e.g. `0.3.0`).
+2. Build the gem locally:
+
+```bash
+bundle install
+bundle exec rake build
+```
+
+3. Create a git tag and push it (this will trigger CI if configured):
+
+```bash
+git add -A
+git commit -m "Release vX.Y.Z"
+git tag vX.Y.Z
+git push origin main --follow-tags
+```
+
+4. Publish the gem to RubyGems interactively (you may need to complete 2FA):
+
+```bash
+gem push pkg/dirfy-X.Y.Z.gem
+```
+
+CI-based release (recommended for automated releases):
+
+1. Ensure the repository has the secret `RUBYGEMS_API_KEY` configured in GitHub Settings → Secrets.
+2. Ensure the repository's token has appropriate permissions to run workflow jobs that create or update releases (the token needs `workflow` scope to update workflows).
+3. Push a tag `vX.Y.Z` to the repo. The `release.yml` workflow will build and push the gem.
+
+Notes and troubleshooting
+
+- If you see an error like `Invalid credentials (401)` during `gem push` in CI, double-check that `RUBYGEMS_API_KEY` is correctly set and that the CI runner writes it to `~/.gem/credentials` before pushing.
+- If GitHub rejects pushes that modify workflow files, ensure the token used has `workflow` scope or make the workflow change via the GitHub web UI.
+- For local gem publishing, if 2FA is enabled you will be prompted to authenticate in your browser or provide an OTP.

data/lib/dirfy/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Dirfy
-  VERSION = "0.3.0"
+  VERSION = "0.3.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dirfy
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Your Name