activeadmin 1.4.3 → 3.0.0

data/CONTRIBUTING.md

@@ -5,15 +5,17 @@ like you that make Active Admin such a great tool.
 
 ### Where do I go from here?
 
-If you've noticed a bug or have a question that doesn't belong on the
-[mailing list][] or [Stack Overflow][], [search the issue tracker][] to see if
-someone else in the community has already created a ticket. If not, go ahead and
-[make one][new issue]!
+If you've noticed a bug or have a feature request, [make one][new issue]! It's
+generally best if you get confirmation of your bug or approval for your feature
+request this way before starting to code.
+
+If you have a general question about activeadmin, you can post it on [Stack
+Overflow], the issue tracker is only for bugs and feature requests.
 
 ### Fork & create a branch
 
-If this is something you think you can fix, then [fork Active Admin][] and
-create a branch with a descriptive name.
+If this is something you think you can fix, then [fork Active Admin] and create
+a branch with a descriptive name.
 
 A good branch name would be (where issue #325 is the ticket you're working on):
 
@@ -23,11 +25,9 @@ git checkout -b 325-add-japanese-translations
 
 ### Get the test suite running
 
-Make sure you're using a recent ruby and have the `bundler` gem installed, at
-least version `1.14.3`.
+Make sure you're using a recent Ruby version.
 
-You'll also need chrome and [chromedriver] installed in order to run cucumber
-scenarios.
+You'll also need chrome installed in order to run cucumber scenarios.
 
 Now install the development dependencies:
 
@@ -35,55 +35,45 @@ Now install the development dependencies:
 bundle install
 ```
 
-Now you should be able to run the entire suite using:
+Then install javascript dependencies with [Yarn] (requires a current version of [Node.js]):
 
 ```sh
-bundle exec rake
+bin/yarn install
 ```
 
-The test run will generate a sample Rails application in `spec/rails` to run the
-tests against.
+JS assets are located in `app/javascript/active_admin`. The config will take care of compiling a complete bundle with [Rollup] using the `build` script and exported to `app/assets/javascripts/active_admin/base.js` ready to be used by Sprockets.
 
-If your tests are passing locally but they're failing on CircleCI, it's probably
-because of some breaking change or problem with the latest version of some
-dependency. You should be able to reproduce the issue locally by:
+To update javascript bundle run (add `-w` flag for watch mode):
 
-* Removing the `Gemfile.lock` file.
-* Running `bundle install`.
-* Re-running the tests again like you did previously.
-
-This is not your fault though, so if this happens feel free to investigate, but
-also feel free to ping maintainers about the issue you just found.
+```sh
+bin/yarn build
+```
 
-If you want to test against a Rails version different from the latest, make sure
-you use the correct Gemfile, for example:
+Now you should be able to run the entire suite using:
 
 ```sh
-export BUNDLE_GEMFILE=gemfiles/rails_51.gemfile
+bin/rake
 ```
 
-### Did you find a bug?
+The task will generate a sample Rails application in `tmp/test_apps` to run the
+test suite against.
 
-* **Ensure the bug was not already reported** by [searching all issues][].
+If you want to test against a Rails version different from the latest, make sure
+you use the correct Gemfile, for example:
 
-* If you're unable to find an open issue addressing the problem,
-  [open a new one][new issue]. Be sure to include a **title and clear
-  description**, as much relevant information as possible, and a **code sample**
-  or an **executable test case** demonstrating the expected behavior that is not
-  occurring.
+```sh
+export BUNDLE_GEMFILE=gemfiles/rails_61/Gemfile
+```
 
-* If possible, use the relevant bug report templates to create the issue.
-  Simply copy the content of the appropriate template into a .rb file, make the
-  necessary changes to demonstrate the issue, and **paste the content into the
-  issue description**:
-  * [**ActiveAdmin** master issues][master template]
+**Warning** SCSS assets are aimed to be used indifferently with Sprockets **and** webpacker.
+As such, make sure not to use any sass-rails directives such as `asset-url` or `image-url`.
 
-### 5. Implement your fix or feature
+### Implement your fix or feature
 
 At this point, you're ready to make your changes! Feel free to ask for help;
 everyone is a beginner at first :smile_cat:
 
-### 6. View your changes in a Rails application
+### View your changes in a Rails application
 
 Active Admin is meant to be used by humans, not cucumbers. So make sure to take
 a look at your changes in a browser.
@@ -91,11 +81,11 @@ a look at your changes in a browser.
 To boot up a test Rails app:
 
 ```sh
-bundle exec rake local server
+bin/rake local server
 ```
 
 This will automatically create a Rails app if none already exists, and store it
-in the `.test-rails-apps` folder.
+in the `tmp/development_apps` folder.
 
 You should now be able to open <http://localhost:3000/admin> in your browser.
 You can log in using:
@@ -107,21 +97,22 @@ If you need to perform any other commands on the test application, just pass
 them to the `local` rake task. For example, to boot the rails console:
 
 ```sh
-bundle exec rake local console
+bin/rake local console
 ```
 
-Or to migrate the database:
+Or to migrate the database, if you create a new migration or just play around
+with the db:
 
 ```sh
-bundle exec rake local db:migrate
+bin/rake local db:migrate
 ```
 
 ### Get the style right
 
 Your patch should follow the same conventions & pass the same code quality
-checks as the rest of the project. `bundle exec rake lint` will give you
-feedback in this regard. You can check & fix style issues by running each linter
-individually. Run `bundle exec rake -T lint` to see the available linters.
+checks as the rest of the project. `bin/rake lint` will give you feedback in
+this regard. You can check & fix style issues by running each linter
+individually. Run `bin/rake -T lint` to see the available linters.
 
 ### Make a Pull Request
 
@@ -144,12 +135,12 @@ git push --set-upstream origin 325-add-japanese-translations
 
 Finally, go to GitHub and [make a Pull Request][] :D
 
-CircleCI will run our test suite against all supported Rails versions. We care
-about quality, so your PR won't be merged until all tests pass. It's unlikely,
-but it's possible that your changes pass tests in one Rails version but fail in
-another. In that case, you'll have to setup your development environment (as
-explained in step 3) to use the problematic Rails version, and investigate
-what's going on!
+Github Actions will run our test suite against all supported Rails versions. We
+care about quality, so your PR won't be merged until all tests pass. It's
+unlikely, but it's possible that your changes pass tests in one Rails version
+but fail in another. In that case, you'll have to setup your development
+environment (as explained in step 3) to use the problematic Rails version, and
+investigate what's going on!
 
 ### Keeping your Pull Request updated
 
@@ -182,35 +173,22 @@ met.
 
 Maintainers need to do the following to push out a release:
 
-* Make sure all pull requests are in and that changelog is current
-* Update `version.rb` file and changelog with new version number
-* If it's not a patch level release, create a stable branch for that release,
-  otherwise switch to the stable branch corresponding to the patch release you
-  want to ship:
-
-  ```sh
-  git checkout master
-  git fetch activeadmin
-  git rebase activeadmin/master
-  # If the release is 2.1.x then this should be: 2-1-stable
-  git checkout -b N-N-stable
-  git push activeadmin N-N-stable:N-N-stable
-  ```
-
+* Switch to the master branch and make sure it's up to date.
 * Make sure you have [chandler] properly configured. Chandler is used to
   automatically submit github release notes from the changelog right after
   pushing the gem to rubygems.
-* `bundle exec rake release`
+* Run one of `bin/rake release:prepare_{prerelease,prepatch,patch,preminor,minor,premajor,major}`, push the result and create a PR.
+* Review and merge the PR. The generated changelog in the PR should include all user visible changes you intend to ship.
+* Run `bin/rake release` from the target branch once the PR is merged.
 
 [chandler]: https://github.com/mattbrictson/chandler#2-configure-credentials
-[chromedriver]: https://sites.google.com/a/chromium.org/chromedriver/getting-started
-[mailing list]: http://groups.google.com/group/activeadmin
 [Stack Overflow]: http://stackoverflow.com/questions/tagged/activeadmin
-[search the issue tracker]: https://github.com/activeadmin/activeadmin/issues?q=something
 [new issue]: https://github.com/activeadmin/activeadmin/issues/new
 [fork Active Admin]: https://help.github.com/articles/fork-a-repo
-[searching all issues]: https://github.com/activeadmin/activeadmin/issues?q=
-[master template]: https://github.com/activeadmin/activeadmin/blob/master/lib/bug_report_templates/active_admin_master.rb
 [make a pull request]: https://help.github.com/articles/creating-a-pull-request
 [git rebasing]: http://git-scm.com/book/en/Git-Branching-Rebasing
-[interactive rebase]: https://help.github.com/articles/interactive-rebase
+[interactive rebase]: https://help.github.com/en/github/using-git/about-git-rebase
+[shortcut reference links]: https://github.github.com/gfm/#shortcut-reference-link
+[Rollup]: https://rollupjs.org/guide/en/#quick-start
+[Yarn]: https://yarnpkg.com/en/docs/install
+[Node.js]: https://nodejs.org/en/

data/README.md

@@ -4,7 +4,7 @@
 creating elegant backends for website administration.
 
 [![Version         ][rubygems_badge]][rubygems]
-[![Circle CI       ][circle_badge]][circle]
+[![Github Actions  ][actions_badge]][actions]
 [![Coverage        ][coverage_badge]][coverage]
 [![Tidelift        ][tidelift_badge]][tidelift]
 [![Inch CI         ][inch_badge]][inch]
@@ -21,6 +21,11 @@ creating elegant backends for website administration.
 * Try the [live demo][demo].
 * The [wiki] includes links to tutorials, articles and sample projects.
 
+## For enterprise
+
+Active Admin for enterprise is available via the Tidelift subscription. [Learn
+More][tidelift_enterprise].
+
 ## Need help?
 
 Please use [StackOverflow][stackoverflow] for help requests and how-to questions.
@@ -32,16 +37,22 @@ Google Groups, IRC #activeadmin and Gitter are not actively monitored.
 
 ## Want to contribute?
 
-The [contributing guide][contributing]
-is a good place to start. If you have questions, feel free to ask.
+If you want to contribute through code or documentation, the [Contributing
+guide is the best place to start][contributing]. If you have questions, feel free
+to ask.
 
 ## Want to support us?
 
-Subscribe to [Tidelift][tidelift] to support Active Admin and get licensing assurances and timely security notifications.
+If you want to support us financially, you can [help fund the project
+through a Tidelift subscription][tidelift_support]. By buying a Tidelift subscription
+you make sure your whole dependency stack is properly maintained, while also
+getting a comprehensive view of outdated dependencies, new releases, security
+alerts, and licensing compatibility issues.
 
-You can support us with a weekly tip via [Liberapay][liberapay.com].
+You can also support us with a weekly tip via [Liberapay].
 
-[![Support via Liberapay][liberapay_button]][liberapay_donate]
+Finally, we have an [Open Collective][opencollective page] where you can become a backer or
+sponsor for the project, and also submit expenses to it.
 
 ## Dependencies
 
@@ -56,6 +67,23 @@ Tool                  | Description
 [Kaminari]            | Elegant pagination for any sort of collection
 [Ransack]             | Provides a simple search API to query your data
 
+## Security contact information
+
+Please use the Tidelift security contact to [report a security vulnerability][Tidelift security contact].
+Tidelift will coordinate the fix and disclosure.
+
+## Acknowledgements
+
+Thanks to [Greg Bell][Greg] for creating and sharing this project with the open source community.
+
+Thanks to [all the people that ever contributed through code][contributors] or
+other means such as bug reports, issue triaging, feature suggestions, code
+snippet tips, Slack discussions and so on.
+
+Thanks to [Tidelift][tidelift] and all our Tidelift subscribers.
+
+Thanks to [Open Collective][opencollective contributors] and all our Open Collective contributors.
+
 [Arbre]: https://github.com/activeadmin/arbre
 [Devise]: https://github.com/plataformatec/devise
 [Formtastic]: https://github.com/justinfrench/formtastic
@@ -65,20 +93,25 @@ Tool                  | Description
 
 [rubygems_badge]: http://img.shields.io/gem/v/activeadmin.svg
 [rubygems]: https://rubygems.org/gems/activeadmin
-[circle_badge]: https://circleci.com/gh/activeadmin/activeadmin/tree/master.svg
-[circle]: https://circleci.com/gh/activeadmin/activeadmin/tree/master
-[coverage_badge]: https://api.codeclimate.com/v1/badges/779e407d22bacff19733/test_coverage
-[coverage]: https://codeclimate.com/github/activeadmin/activeadmin/test_coverage
+[actions_badge]: https://github.com/activeadmin/activeadmin/workflows/ci/badge.svg
+[actions]: https://github.com/activeadmin/activeadmin/actions
+[coverage_badge]: https://codecov.io/gh/activeadmin/activeadmin/branch/master/graph/badge.svg?token=NAjeBdkQXW
+[coverage]: https://codecov.io/gh/activeadmin/activeadmin
 [inch_badge]: http://inch-ci.org/github/activeadmin/activeadmin.svg?branch=master
 [inch]: http://inch-ci.org/github/activeadmin/activeadmin
 [tidelift_badge]: https://tidelift.com/badges/github/activeadmin/activeadmin
 [tidelift]: https://tidelift.com/subscription/pkg/rubygems-activeadmin?utm_source=rubygems-activeadmin&utm_medium=readme
+[tidelift_enterprise]: https://tidelift.com/subscription/pkg/rubygems-activeadmin?utm_source=rubygems-activeadmin&utm_medium=referral&utm_campaign=enterprise
+[tidelift_support]: https://tidelift.com/subscription/pkg/rubygems-activeadmin?utm_source=rubygems-activeadmin&utm_medium=referral&utm_campaign=github&utm_content=support
 
 [docs]: http://activeadmin.info/0-installation.html
 [demo]: http://demo.activeadmin.info/admin
 [wiki]: https://github.com/activeadmin/activeadmin/wiki
 [stackoverflow]: http://stackoverflow.com/questions/tagged/activeadmin
 [contributing]: https://github.com/activeadmin/activeadmin/blob/master/CONTRIBUTING.md
-[liberapay.com]: https://liberapay.com
-[liberapay_button]: https://liberapay.com/assets/widgets/donate.svg
-[liberapay_donate]: https://liberapay.com/Active-Admin/donate
+[Liberapay]: https://liberapay.com/Active-Admin/donate
+[Tidelift security contact]: https://tidelift.com/security
+[Greg]: https://github.com/gregbell
+[contributors]: https://github.com/activeadmin/activeadmin/graphs/contributors
+[opencollective page]: https://opencollective.com/activeadmin
+[opencollective contributors]: https://opencollective.com/activeadmin#contributors