bullet_train 1.10.0 → 1.12.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/docs/upgrades.md +43 -2
- data/lib/bullet_train/version.rb +1 -1
- metadata +17 -4
- data/config/models/roles.yml +0 -37
    
        checksums.yaml
    CHANGED
    
    | @@ -1,7 +1,7 @@ | |
| 1 1 | 
             
            ---
         | 
| 2 2 | 
             
            SHA256:
         | 
| 3 | 
            -
              metadata.gz:  | 
| 4 | 
            -
              data.tar.gz:  | 
| 3 | 
            +
              metadata.gz: bd6fdf70fe639d436c4c3a30bdb7334486a06fd164cc1143cfb7c61f594807a1
         | 
| 4 | 
            +
              data.tar.gz: 26bfbb1745af219cc5e1a88c63960091e988060b99e6d8c663849a182a2e2d75
         | 
| 5 5 | 
             
            SHA512:
         | 
| 6 | 
            -
              metadata.gz:  | 
| 7 | 
            -
              data.tar.gz:  | 
| 6 | 
            +
              metadata.gz: 405d7b2680925803f52982019d1311f494b4bfb0d798b45898fc98afe6a2a0e2ce49e83af6ed2dc73fe6ba6f693a699a439e923d9ace5715e35fd68d3c4b2c59
         | 
| 7 | 
            +
              data.tar.gz: 1889ac585f748aaf37f4917750e5d4d26e8214a7aa164d8fe45354eab0f24d182ee3dc7bde4b2f45be3c3fe2b08a6d4788539b6bc95b5c14f66c969b79d55397
         | 
    
        data/docs/upgrades.md
    CHANGED
    
    | @@ -14,8 +14,49 @@ | |
| 14 14 |  | 
| 15 15 | 
             
            ## The Stepwise Upgrade Method
         | 
| 16 16 |  | 
| 17 | 
            -
            This method will ensure that the version of the Bullet Train gems that your app uses will stay in sync | 
| 18 | 
            -
            If you've ever upgraded a Rails app from | 
| 17 | 
            +
            This method will ensure that the version of the Bullet Train gems that your app uses will stay in sync
         | 
| 18 | 
            +
            with the application framework provided by the starter repo. If you've ever upgraded a Rails app from
         | 
| 19 | 
            +
            version to version this process should feel fairly similar.
         | 
| 20 | 
            +
             | 
| 21 | 
            +
            We recommend gradually upgrading one version at a time. This makes it relatively easy to pinpoint any
         | 
| 22 | 
            +
            specific changes that may cause problems with your app. Trying to jump a bunch of versions at once can
         | 
| 23 | 
            +
            make it hard to figure out exactly where problems are coming from.
         | 
| 24 | 
            +
             | 
| 25 | 
            +
            The basic idea is that if you're on `1.4.0` you should upgrade next to `1.4.1`, run your tests, deploy
         | 
| 26 | 
            +
            those changes and make sure things are working well. Then upgrade to `1.4.2` etc... If you update regularly
         | 
| 27 | 
            +
            then each individual update should be relatively small.
         | 
| 28 | 
            +
             | 
| 29 | 
            +
            For performing the upgrade you have two options:
         | 
| 30 | 
            +
             | 
| 31 | 
            +
            * [Use the GitHub Action we provide to create an upgrade Pull Request](./upgrades#github-action)
         | 
| 32 | 
            +
            * [Performa a manual upgrade via git](./upgrades#manual-upgrade)
         | 
| 33 | 
            +
             | 
| 34 | 
            +
            ## GitHub Action
         | 
| 35 | 
            +
             | 
| 36 | 
            +
            First go to the "Actions" tab on your project and then click on the "↗️  Create Bullet Train Upgrade PR" link on the left.
         | 
| 37 | 
            +
             | 
| 38 | 
            +
            
         | 
| 39 | 
            +
             | 
| 40 | 
            +
            Then on the right side of the page click the "Run workflow" button and enter the target version. `1.4.1` for instance.
         | 
| 41 | 
            +
            If you don't enter a version number then the action will target the latest version available on GitHub.
         | 
| 42 | 
            +
             | 
| 43 | 
            +
            
         | 
| 44 | 
            +
             | 
| 45 | 
            +
            A few seconds after you click the green "Run workflow" button you should see a new action running.
         | 
| 46 | 
            +
             | 
| 47 | 
            +
            
         | 
| 48 | 
            +
             | 
| 49 | 
            +
            Once the action has completed you should have a new Pull Request that will perform the upgrade.
         | 
| 50 | 
            +
             | 
| 51 | 
            +
            
         | 
| 52 | 
            +
             | 
| 53 | 
            +
            You should review the contents of the pull request, run the tests, and pull down the branch to run it locally.
         | 
| 54 | 
            +
             | 
| 55 | 
            +
            [Here's a sample of the kind of Pull Request that you'll get. This is from a recent upgrade of the Bullet Train demo site.](https://github.com/bullet-train-co/bullet_train-demo_site/pull/47)
         | 
| 56 | 
            +
             | 
| 57 | 
            +
            The GitHub action is basically an automated version of the manual upgrade process described below.
         | 
| 58 | 
            +
             | 
| 59 | 
            +
            ## Manual Upgrade
         | 
| 19 60 |  | 
| 20 61 | 
             
            ## Pulling Updates from the Starter Repository
         | 
| 21 62 |  | 
    
        data/lib/bullet_train/version.rb
    CHANGED
    
    
    
        metadata
    CHANGED
    
    | @@ -1,14 +1,14 @@ | |
| 1 1 | 
             
            --- !ruby/object:Gem::Specification
         | 
| 2 2 | 
             
            name: bullet_train
         | 
| 3 3 | 
             
            version: !ruby/object:Gem::Version
         | 
| 4 | 
            -
              version: 1. | 
| 4 | 
            +
              version: 1.12.0
         | 
| 5 5 | 
             
            platform: ruby
         | 
| 6 6 | 
             
            authors:
         | 
| 7 7 | 
             
            - Andrew Culver
         | 
| 8 8 | 
             
            autorequire: 
         | 
| 9 9 | 
             
            bindir: bin
         | 
| 10 10 | 
             
            cert_chain: []
         | 
| 11 | 
            -
            date: 2024- | 
| 11 | 
            +
            date: 2024-12-10 00:00:00.000000000 Z
         | 
| 12 12 | 
             
            dependencies:
         | 
| 13 13 | 
             
            - !ruby/object:Gem::Dependency
         | 
| 14 14 | 
             
              name: standard
         | 
| @@ -24,6 +24,20 @@ dependencies: | |
| 24 24 | 
             
                - - ">="
         | 
| 25 25 | 
             
                  - !ruby/object:Gem::Version
         | 
| 26 26 | 
             
                    version: '0'
         | 
| 27 | 
            +
            - !ruby/object:Gem::Dependency
         | 
| 28 | 
            +
              name: simplecov
         | 
| 29 | 
            +
              requirement: !ruby/object:Gem::Requirement
         | 
| 30 | 
            +
                requirements:
         | 
| 31 | 
            +
                - - ">="
         | 
| 32 | 
            +
                  - !ruby/object:Gem::Version
         | 
| 33 | 
            +
                    version: '0'
         | 
| 34 | 
            +
              type: :development
         | 
| 35 | 
            +
              prerelease: false
         | 
| 36 | 
            +
              version_requirements: !ruby/object:Gem::Requirement
         | 
| 37 | 
            +
                requirements:
         | 
| 38 | 
            +
                - - ">="
         | 
| 39 | 
            +
                  - !ruby/object:Gem::Version
         | 
| 40 | 
            +
                    version: '0'
         | 
| 27 41 | 
             
            - !ruby/object:Gem::Dependency
         | 
| 28 42 | 
             
              name: rails
         | 
| 29 43 | 
             
              requirement: !ruby/object:Gem::Requirement
         | 
| @@ -109,7 +123,7 @@ dependencies: | |
| 109 123 | 
             
                  - !ruby/object:Gem::Version
         | 
| 110 124 | 
             
                    version: '0'
         | 
| 111 125 | 
             
            - !ruby/object:Gem::Dependency
         | 
| 112 | 
            -
              name: bullet_train- | 
| 126 | 
            +
              name: bullet_train-fields
         | 
| 113 127 | 
             
              requirement: !ruby/object:Gem::Requirement
         | 
| 114 128 | 
             
                requirements:
         | 
| 115 129 | 
             
                - - ">="
         | 
| @@ -694,7 +708,6 @@ files: | |
| 694 708 | 
             
            - config/locales/en/teams.en.yml
         | 
| 695 709 | 
             
            - config/locales/en/users.en.yml
         | 
| 696 710 | 
             
            - config/locales/localization.en.yml
         | 
| 697 | 
            -
            - config/models/roles.yml
         | 
| 698 711 | 
             
            - config/routes.rb
         | 
| 699 712 | 
             
            - db/migrate/20161115160419_devise_create_users.rb
         | 
| 700 713 | 
             
            - db/migrate/20161116003852_add_api_key_to_user.rb
         | 
    
        data/config/models/roles.yml
    DELETED
    
    | @@ -1,37 +0,0 @@ | |
| 1 | 
            -
            default:
         | 
| 2 | 
            -
              models:
         | 
| 3 | 
            -
                Team: read
         | 
| 4 | 
            -
                Document: read
         | 
| 5 | 
            -
                Membership:
         | 
| 6 | 
            -
                  - read
         | 
| 7 | 
            -
                  - search
         | 
| 8 | 
            -
             | 
| 9 | 
            -
            crud_role:
         | 
| 10 | 
            -
              models:
         | 
| 11 | 
            -
                Team: crud
         | 
| 12 | 
            -
             | 
| 13 | 
            -
            editor:
         | 
| 14 | 
            -
              models:
         | 
| 15 | 
            -
                Scaffolding::AbsolutelyAbstract::CreativeConcept:
         | 
| 16 | 
            -
                  - read
         | 
| 17 | 
            -
                  - update
         | 
| 18 | 
            -
             | 
| 19 | 
            -
            manager:
         | 
| 20 | 
            -
              includes:
         | 
| 21 | 
            -
                - editor
         | 
| 22 | 
            -
             | 
| 23 | 
            -
            supervisor:
         | 
| 24 | 
            -
              includes:
         | 
| 25 | 
            -
                - manager
         | 
| 26 | 
            -
             | 
| 27 | 
            -
            admin:
         | 
| 28 | 
            -
              includes:
         | 
| 29 | 
            -
                - editor
         | 
| 30 | 
            -
              manageable_roles:
         | 
| 31 | 
            -
                - admin
         | 
| 32 | 
            -
                - editor
         | 
| 33 | 
            -
              models:
         | 
| 34 | 
            -
                Team: manage
         | 
| 35 | 
            -
                Membership: manage
         | 
| 36 | 
            -
                Document: manage
         | 
| 37 | 
            -
                Scaffolding::AbsolutelyAbstract::CreativeConcept: manage
         |