Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Fix bootstrap script and general improvements #45

Merged
merged 7 commits into from
Nov 5, 2024

Conversation

martimlobao
Copy link
Owner

@martimlobao martimlobao commented Nov 5, 2024

  • proper bootstrap script
  • rename setup.sh to run.sh and clean up
  • remove need for sudo in local.sh
  • move computer rename to macos.sh
  • create dotsync.sh
  • disable auto-run for macos.sh (needs fixing)
  • update readme and license
  • general cleanup

Summary by Sourcery

Revamp the bootstrap process by introducing a new 'dotsync.sh' script for dotfile management, renaming 'setup.sh' to 'run.sh', and removing 'sudo' requirements from 'local.sh'. Update the README and LICENSE to reflect these changes and improve script idempotency and security by integrating 1Password for secret management.

New Features:

  • Introduce a new script 'dotsync.sh' for managing dotfiles linking and unlinking.

Enhancements:

  • Rename 'setup.sh' to 'run.sh' and streamline its functionality.
  • Remove the need for 'sudo' in 'local.sh' to enhance security and usability.
  • Move computer renaming functionality from 'local.sh' to 'macos.sh'.
  • Make scripts idempotent, allowing them to be run multiple times without issues.
  • Add support for 1Password to manage secrets used by scripts.

Documentation:

  • Update README.md to reflect changes in script names and usage instructions.
  • Revise LICENSE.md to update copyright years.

- proper bootstrap script
- rename setup.sh to run.sh and clean up
- remove need for sudo in local.sh
- move computer rename to macos.sh
- create dotsync.sh
- general cleanup
Copy link
Contributor

sourcery-ai bot commented Nov 5, 2024

Reviewer's Guide by Sourcery

This PR reorganizes and improves the dotfiles setup scripts by introducing proper bootstrapping, better script organization, and automated installation capabilities. The changes focus on making the installation process more streamlined, adding 1Password integration for secrets management, and improving the overall user experience with better feedback and idempotent operations.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Reorganized script structure and improved bootstrapping process
  • Created new bootstrap.sh script for initial setup and repository cloning
  • Renamed setup.sh to run.sh with improved organization and sequencing
  • Created new dotsync.sh for managing dotfile symlinks
  • Added support for automated installation with --yes/-y flags
bootstrap.sh
run.sh
dotsync.sh
Integrated 1Password for secrets management
  • Added 1Password authentication check
  • Implemented secure retrieval of git configuration values
  • Added secure storage of application license keys
  • Added documentation for required 1Password secrets
local.sh
README.md
Improved installation process and script behavior
  • Made all scripts idempotent
  • Removed sudo requirement from local.sh
  • Added better console output with colored status messages
  • Simplified installation command with curl shortlink
local.sh
install.sh
dock.sh
README.md
Updated documentation and simplified installation instructions
  • Streamlined README with clearer installation steps
  • Added 1Password requirements section
  • Removed outdated installation methods
  • Updated license and acknowledgments
README.md
LICENSE.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @martimlobao - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider adding a comment in run.sh explaining why macos.sh is disabled and what needs to be fixed before re-enabling it
Here's what I looked at during the review
  • 🟡 General issues: 1 issue found
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟡 Documentation: 1 issue found

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

bootstrap.sh Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
martimlobao and others added 5 commits November 5, 2024 02:31
Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
…bao/dotfiles into chore/bugfixes-and-improvements
@martimlobao martimlobao merged commit cc8340c into main Nov 5, 2024
3 checks passed
@martimlobao martimlobao deleted the chore/bugfixes-and-improvements branch November 5, 2024 02:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant