You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: release_notes_template.md
+6
Original file line number
Diff line number
Diff line change
@@ -1,3 +1,8 @@
1
+
# (PART) Appendix {-}
2
+
3
+
# Release Notes Template {-}
4
+
5
+
```
1
6
[one line summary]
2
7
3
8
[full summary]
@@ -66,3 +71,4 @@ The database version for this release is [migration id].
66
71
```
67
72
68
73
Complete instructions for setting up the test database and running the RSpec tests are on the Wiki page at https://github.com/PecanProject/bety/wiki/Automated-Tests
Copy file name to clipboardExpand all lines: ruby_on_rails_application_overview.md
+11-12
Original file line number
Diff line number
Diff line change
@@ -1,17 +1,16 @@
1
-
# Ruby on Rails Application Overview
2
-
1
+
<!-- Possibly rename this file -->
3
2
# Ruby-on-Rails: Developing, Upgrading, and Deploying
4
3
5
4
## Development and Testing
6
5
7
-
Testing is an integral part of releasing a new version of the BETYdb Rails app. Developers should test prospective code on their development machines prior to submitting a pull request, and code managers should re-test the code before accepting a pull request. See [[running the automated tests | automated-tests]] for complete testing instructions.
6
+
Testing is an integral part of releasing a new version of the BETYdb Rails app. Developers should test prospective code on their development machines prior to submitting a pull request, and code managers should re-test the code before accepting a pull request. See [Automated Tests] for complete testing instructions.
8
7
9
8
10
9
## Deploying a new version:
11
10
12
-
**For up-to-date instructions on making a new release, see https://dlebauer.gitbooks.io/betydb-documentation/content/management/making_a_new_release.html**
11
+
**For up-to-date instructions on making a new release, see [Issuing a New Release].**
13
12
14
-
At the end of each sprint (or set of sprints, or when ready to deploy a new version), the version should be tagged, and a "release" should be created. See the [[Release Notes Template | Release-Notes-Template]] page for a sample draft of release notes.
13
+
At the end of each sprint (or set of sprints, or when ready to deploy a new version), the version should be tagged, and a "release" should be created. See the [Release Notes Template] page for a sample draft of release notes.
15
14
16
15
17
16
(We use the terms "deploy" and "upgrade" roughly synonymously, but "deploy" connotes what code manager does when providing a new version of BETYdb to, say, the production server, and "upgrade" connotes what developers maintaining their own copies of BETYdb do to keep those copies up-to-date. Making a new "release" is part of the deployment process but is not part of the upgrade process for individual users.
@@ -76,9 +75,9 @@ If you do not wish to install the test pieces you can run `bundle install --with
76
75
[Note: If you can't or don't wish to install the capybara-webkit gem, you can comment it out in the Gemfile. It is only needed for testing the RSpec tests and it is only needed for a few of them. To avoid running the tests that require it, run rspec with the "--tag ~js" option.]
77
76
78
77
79
-
At this point, the site can be tested, both through the browser and by running the [[automated tests]]. [To do: write hints for running automated tests on production servers]
78
+
At this point, the site can be tested, both through the browser and by running the [Automated Tests]. [To do: write hints for running automated tests on production servers]
80
79
81
-
_reference:_[protocol for pull requests, testing etc. were discussed in [#48](https://github.com/PecanProject/bety/issues/48)]
80
+
_reference:_[protocol for pull requests, testing etc. were discussed in [bety issue #48](https://github.com/PecanProject/bety/issues/48){target="_blank"}]
82
81
83
82
### Running Migrations
84
83
@@ -118,7 +117,7 @@ deployments of the BetyDB database should have precisely the same
118
117
structure. But in case they do not, we want to capture what is
119
118
actually be used live.)
120
119
121
-
Note that we no longer use the `schema.rb` file (see https://github.com/PecanProject/bety/issues/44). The `structure.sql` files allow for complete documentation of the database structure, including features that (by default) are not expressible in the `schema.rb` file. <strong>production_structure.sql is the canonical specification of the complete database schema, the schema which the Rails code is meant to be run against.</strong>
120
+
Note that we no longer use the `schema.rb` file (see [bety issue #44](https://github.com/PecanProject/bety/issues/44){target="_blank"}). The `structure.sql` files allow for complete documentation of the database structure, including features that (by default) are not expressible in the `schema.rb` file. <strong>production_structure.sql is the canonical specification of the complete database schema, the schema which the Rails code is meant to be run against.</strong>
122
121
123
122
## Versioning and Tagging
124
123
@@ -129,7 +128,7 @@ Note that we no longer use the `schema.rb` file (see https://github.com/PecanPro
129
128
1. Merge pull requests into the master branch of PecanProject/bety as
130
129
necessary (in order to avoid conflicts, preferably within one working
131
130
day) .
132
-
1.[to-do: clarify how we handle pre-releases and why they are necessary] Create a [pre-release](https://github.com/PecanProject/bety/releases/new). This should include a list of key expected features to be implemented during the sprint.
131
+
1.[to-do: clarify how we handle pre-releases and why they are necessary] Create a [pre-release](https://github.com/PecanProject/bety/releases/new){target="_blank"}. This should include a list of key expected features to be implemented during the sprint.
133
132
1. If critical bug fix is required on production server:
134
133
1. Create a branch off of the currently-deployed master version. (If subsequent critical bug fixes are later needed, they can also go on this branch.)
135
134
1. Apply the bug fix to the branch.
@@ -157,7 +156,7 @@ Note that we no longer use the `schema.rb` file (see https://github.com/PecanPro
157
156
158
157
### Version Numbering
159
158
160
-
We loosely follow [semantic versioning](http://semver.org/).
159
+
We loosely follow [semantic versioning](http://semver.org/){target="_blank"}.
161
160
162
161
* Any tag of the form betydb\_x.x or betydb\_x.x.x refers to a version that has been tested and deployed.
163
162
* Changes in the first or second digit of the version number mark some
@@ -169,8 +168,8 @@ We loosely follow [semantic versioning](http://semver.org/).
0 commit comments