{"action":"created","comment":{"url":"https://api.github.com/repos/architecture-building-systems/CEAforArcGIS/pulls/comments/115698664","pull_request_review_id":37257820,"id":115698664,"diff_hunk":"@@ -0,0 +1,151 @@\n+How to create a new release\n+===========================\n+\n+This section describes the steps necessary to create a new release of the City Energy Analyst (CEA).\n+\n+Versioning\n+----------\n+\n+Each release of the CEA needs a version number. Version numbers need to increase for PyPI_. The relevant documentation\n+for python version numbers is documented in PEP440_. The CEA uses the following versioning scheme in compliance with\n+PEP440_:\n+\n+    major.minor[.revision][pre-release]\n+\n+Major and minor version segments in this scheme refer to the milestone (sprint) the release was developed for. The\n+major version segment works on roughly a yearly time scale while the minor version segment tracks sprints inside the\n+major release. Each such pair (major.minor) refers to a \"milestone\" in the `GitHub issues milestones list`_.\n+\n+If a release needs to be updated after publishing, an optional revision can be used, starting at 1 and incrementing.\n+\n+During the sprint, the pre-release section is used to represent the current state of the master branch. At the beginning\n+of the sprint, alpha versions are used. Examples: 2.2a0, 2.2a1, 2.2a2, etc. In this phase the issues belonging to the\n+milestone are being added.\n+\n+Once the code base settles down, beta versions can be used. Examples: 2.2b0, 2.2b1, 2.2b2, etc. In this phase, new\n+features should not be added anymore and instead testing / bug fixing activities should dominate.\n+\n+Before releasing a milestone, the release candidates can be used. Examples: 2.2rc0, 2.2rc1, 2.2rc2, etc. In this phase\n+the software is just being tested with show-stopping bugs being fixed if possible.\n+\n+Where to find the current version number\n+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n+\n+The current version number can be found in the module :py:mod:`cea` (actually, since :py:mod:`cea` is a package, you\n+need to look into the file ``__init__.py``) in the variable ``__version__``.\n+All code requiring knowledge of the current version number should read the version from here. In python this can be\n+achieved by:\n+\n+.. source: python\n+\n+    import cea\n+    version_number = cea.__version__\n+\n+\n+The NSIS installer uses the helper tool ``setup/get_version.exe`` to extract the version and write it to the file\n+``setup/cea_version.txt`` - if importing :py:mod:`cea` is not an option, you could explore this avenue too...\n+\n+\n+Responsibility for version numbers\n+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n+\n+The repository admin merging a pull request to master is responsible for updating the version number.\n+\n+\n+.. _PyPI: https://pypi.python.org/pypi\n+.. _PEP440: https://www.python.org/dev/peps/pep-0440\n+.. _GitHub issues milestones list: https://github.com/architecture-building-systems/CEAforArcGIS/milestones\n+\n+\n+Update the CREDITS.md file\n+--------------------------\n+\n+For each minor release (2.2, 2.3, ...) the ``CREDITS.md`` file needs to be updated to include all the authors that\n+worked on that release.\n+\n+@JIMENO: Do I understand this correctly: The list is ever expanding? Then we also might need a HISTORY.md file or","path":"docs/how-to-create-a-new-release.rst","position":67,"original_position":66,"commit_id":"ca76c89255c1e7960f6a4a7072359d0ba7554303","original_commit_id":"f36859b939f3fa556a2d523f37776361280348dc","user":{"login":"JIMENOFONSECA","id":8973186,"avatar_url":"https://avatars0.githubusercontent.com/u/8973186?v=3","gravatar_id":"","url":"https://api.github.com/users/JIMENOFONSECA","html_url":"https://github.com/JIMENOFONSECA","followers_url":"https://api.github.com/users/JIMENOFONSECA/followers","following_url":"https://api.github.com/users/JIMENOFONSECA/following{/other_user}","gists_url":"https://api.github.com/users/JIMENOFONSECA/gists{/gist_id}","starred_url":"https://api.github.com/users/JIMENOFONSECA/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/JIMENOFONSECA/subscriptions","organizations_url":"https://api.github.com/users/JIMENOFONSECA/orgs","repos_url":"https://api.github.com/users/JIMENOFONSECA/repos","events_url":"https://api.github.com/users/JIMENOFONSECA/events{/privacy}","received_events_url":"https://api.github.com/users/JIMENOFONSECA/received_events","type":"User","site_admin":false},"body":"good point. let's do it that way. (the unit of credits should be a release\r\n","created_at":"2017-05-10T09:49:29Z","updated_at":"2017-05-10T09:49:29Z","html_url":"https://github.com/architecture-building-systems/CEAforArcGIS/pull/624#discussion_r115698664","pull_request_url":"https://api.github.com/repos/architecture-building-systems/CEAforArcGIS/pulls/624","_links":{"self":{"href":"https://api.github.com/repos/architecture-building-systems/CEAforArcGIS/pulls/comments/115698664"},"html":{"href":"https://github.com/architecture-building-systems/CEAforArcGIS/pull/624#discussion_r115698664"},"pull_request":{"href":"https://api.github.com/repos/architecture-building-systems/CEAforArcGIS/pulls/624"}}},"pull_request":{"url":"https://api.github.com/repos/architecture-building-systems/CEAforArcGIS/pulls/624","id":118135557,"html_url":"https://github.com/architecture-building-systems/CEAforArcGIS/pull/624","diff_url":"https://github.com/architecture-building-systems/CEAforArcGIS/pull/624.diff","patch_url":"https://github.com/architecture-building-systems/CEAforArcGIS/pull/624.patch","issue_url":"https://api.github.com/repos/architecture-building-systems/CEAforArcGIS/issues/624","number":624,"state":"open","locked":false,"title":"607 document steps to create arelease","user":{"login":"daren-thomas","id":2969564,"avatar_url":"https://avatars0.githubusercontent.com/u/2969564?v=3","gravatar_id":"","url":"https://api.github.com/users/daren-thomas","html_url":"https://github.com/daren-thomas","followers_url":"https://api.github.com/users/daren-thomas/followers","following_url":"https://api.github.com/users/daren-thomas/following{/other_user}","gists_url":"https://api.github.com/users/daren-thomas/gists{/gist_id}","starred_url":"https://api.github.com/users/daren-thomas/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/daren-thomas/subscriptions","organizations_url":"https://api.github.com/users/daren-thomas/orgs","repos_url":"https://api.github.com/users/daren-thomas/repos","events_url":"https://api.github.com/users/daren-thomas/events{/privacy}","received_events_url":"https://api.github.com/users/daren-thomas/received_events","type":"User","site_admin":false},"body":"@JIMENOFONSECA this pull request addresses #607 - how to create a release of the CEA. Including uploading to PyPI, testing the documentation, additional tools needed and compiling the installer for the planner's version.\r\n\r\nIf I forgot something, please let me know.","created_at":"2017-04-28T11:46:19Z","updated_at":"2017-05-10T09:49:29Z","closed_at":null,"merged_at":null,"merge_commit_sha":"94d6f16ffc36509d12c50837c8b1393b33ed3968","assignee":null,"assignees":[],"requested_reviewers":[],"milestone":null,"commits_url":"https://api.github.com/repos/architecture-building-systems/CEAforArcGIS/pulls/624/commits","review_comments_url":"https://api.github.com/repos/architecture-building-systems/CEAforArcGIS/pulls/624/comments","review_comment_url":"https://api.github.com/repos/architecture-building-systems/CEAforArcGIS/pulls/comments{/number}","comments_url":"https://api.github.com/repos/architecture-building-systems/CEAforArcGIS/issues/624/comments","statuses_url":"https://api.github.com/repos/architecture-building-systems/CEAforArcGIS/statuses/ca76c89255c1e7960f6a4a7072359d0ba7554303","head":{"label":"architecture-building-systems:607-document-steps-to-create-arelease","ref":"607-document-steps-to-create-arelease","sha":"ca76c89255c1e7960f6a4a7072359d0ba7554303","user":{"login":"architecture-building-systems","id":8478952,"avatar_url":"https://avatars3.githubusercontent.com/u/8478952?v=3","gravatar_id":"","url":"https://api.github.com/users/architecture-building-systems","html_url":"https://github.com/architecture-building-systems","followers_url":"https://api.github.com/users/architecture-building-systems/followers","following_url":"https://api.github.com/users/architecture-building-systems/following{/other_user}","gists_url":"https://api.github.com/users/architecture-building-systems/gists{/gist_id}","starred_url":"https://api.github.com/users/architecture-building-systems/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/architecture-building-systems/subscriptions","organizations_url":"https://api.github.com/users/architecture-building-systems/orgs","repos_url":"https://api.github.com/users/architecture-building-systems/repos","events_url":"https://api.github.com/users/architecture-building-systems/events{/privacy}","received_events_url":"https://api.github.com/users/architecture-building-systems/received_events","type":"Organization","site_admin":false},"repo":{"id":49491341,"name":"CEAforArcGIS","full_name":"architecture-building-systems/CEAforArcGIS","owner":{"login":"architecture-building-systems","id":8478952,"avatar_url":"https://avatars3.githubusercontent.com/u/8478952?v=3","gravatar_id":"","url":"https://api.github.com/users/architecture-building-systems","html_url":"https://github.com/architecture-building-systems","followers_url":"https://api.github.com/users/architecture-building-systems/followers","following_url":"https://api.github.com/users/architecture-building-systems/following{/other_user}","gists_url":"https://api.github.com/users/architecture-building-systems/gists{/gist_id}","starred_url":"https://api.github.com/users/architecture-building-systems/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/architecture-building-systems/subscriptions","organizations_url":"https://api.github.com/users/architecture-building-systems/orgs","repos_url":"https://api.github.com/users/architecture-building-systems/repos","events_url":"https://api.github.com/users/architecture-building-systems/events{/privacy}","received_events_url":"https://api.github.com/users/architecture-building-systems/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/architecture-building-systems/CEAforArcGIS","description":"The City Energy Analyst (CEA)","fork":false,"url":"https://api.github.com/repos/architecture-building-systems/CEAforArcGIS","forks_url":"https://api.github.com/repos/architecture-building-systems/CEAforArcGIS/forks","keys_url":"https://api.github.com/repos/architecture-building-systems/CEAforArcGIS/keys{/key_id}","collaborators_url":"https://api.github.com/repos/architecture-building-systems/CEAforArcGIS/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/architecture-building-systems/CEAforArcGIS/teams","hooks_url":"https://api.github.com/repos/architecture-building-systems/CEAforArcGIS/hooks","issue_events_url":"https://api.github.com/repos/architecture-building-systems/CEAforArcGIS/issues/events{/number}","events_url":"https://api.github.com/repos/architecture-building-systems/CEAforArcGIS/events","assignees_url":"https://api.github.com/repos/architecture-building-systems/CEAforArcGIS/assignees{/user}","branches_url":"https://api.github.com/repos/architecture-building-systems/CEAforArcGIS/branches{/branch}","tags_url":"https://api.github.com/repos/architecture-building-systems/CEAforArcGIS/tags","blobs_url":"https://api.github.com/repos/architecture-building-systems/CEAforArcGIS/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/architecture-building-systems/CEAforArcGIS/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/architecture-building-systems/CEAforArcGIS/git/refs{/sha}","trees_url":"https://api.github.com/repos/architecture-building-systems/CEAforArcGIS/git/trees{/sha}","statuses_url":"https://api.github.com/repos/architecture-building-systems/CEAforArcGIS/statuses/{sha}","languages_url":"https://api.github.com/repos/architecture-building-systems/CEAforArcGIS/languages","stargazers_url":"https://api.github.com/repos/architecture-building-systems/CEAforArcGIS/stargazers","contributors_url":"https://api.github.com/repos/architecture-building-systems/CEAforArcGIS/contributors","subscribers_url":"https://api.github.com/repos/architecture-building-systems/CEAforArcGIS/subscribers","subscription_url":"https://api.github.com/repos/architecture-building-systems/CEAforArcGIS/subscription","commits_url":"https://api.github.com/repos/architecture-building-systems/CEAforArcGIS/commits{/sha}","git_commits_url":"https://api.github.com/repos/architecture-building-systems/CEAforArcGIS/git/commits{/sha}","comments_url":"https://api.github.com/repos/architecture-building-systems/CEAforArcGIS/comments{/number}","issue_comment_url":"https://api.github.com/repos/architecture-building-systems/CEAforArcGIS/issues/comments{/number}","contents_url":"https://api.github.com/repos/architecture-building-systems/CEAforArcGIS/contents/{+path}","compare_url":"https://api.github.com/repos/architecture-building-systems/CEAforArcGIS/compare/{base}...{head}","merges_url":"https://api.github.com/repos/architecture-building-systems/CEAforArcGIS/merges","archive_url":"https://api.github.com/repos/architecture-building-systems/CEAforArcGIS/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/architecture-building-systems/CEAforArcGIS/downloads","issues_url":"https://api.github.com/repos/architecture-building-systems/CEAforArcGIS/issues{/number}","pulls_url":"https://api.github.com/repos/architecture-building-systems/CEAforArcGIS/pulls{/number}","milestones_url":"https://api.github.com/repos/architecture-building-systems/CEAforArcGIS/milestones{/number}","notifications_url":"https://api.github.com/repos/architecture-building-systems/CEAforArcGIS/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/architecture-building-systems/CEAforArcGIS/labels{/name}","releases_url":"https://api.github.com/repos/architecture-building-systems/CEAforArcGIS/releases{/id}","deployments_url":"https://api.github.com/repos/architecture-building-systems/CEAforArcGIS/deployments","created_at":"2016-01-12T10:02:17Z","updated_at":"2017-04-10T07:56:52Z","pushed_at":"2017-05-10T09:42:13Z","git_url":"git://github.com/architecture-building-systems/CEAforArcGIS.git","ssh_url":"git@github.com:architecture-building-systems/CEAforArcGIS.git","clone_url":"https://github.com/architecture-building-systems/CEAforArcGIS.git","svn_url":"https://github.com/architecture-building-systems/CEAforArcGIS","homepage":"","size":227019,"stargazers_count":8,"watchers_count":8,"language":"Python","has_issues":true,"has_projects":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":3,"mirror_url":null,"open_issues_count":135,"forks":3,"open_issues":135,"watchers":8,"default_branch":"master"}},"base":{"label":"architecture-building-systems:master","ref":"master","sha":"5f4d386500d67843c4308ccde3483548ad58ca54","user":{"login":"architecture-building-systems","id":8478952,"avatar_url":"https://avatars3.githubusercontent.com/u/8478952?v=3","gravatar_id":"","url":"https://api.github.com/users/architecture-building-systems","html_url":"https://github.com/architecture-building-systems","followers_url":"https://api.github.com/users/architecture-building-systems/followers","following_url":"https://api.github.com/users/architecture-building-systems/following{/other_user}","gists_url":"https://api.github.com/users/architecture-building-systems/gists{/gist_id}","starred_url":"https://api.github.com/users/architecture-building-systems/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/architecture-building-systems/subscriptions","organizations_url":"https://api.github.com/users/architecture-building-systems/orgs","repos_url":"https://api.github.com/users/architecture-building-systems/repos","events_url":"https://api.github.com/users/architecture-building-systems/events{/privacy}","received_events_url":"https://api.github.com/users/architecture-building-systems/received_events","type":"Organization","site_admin":false},"repo":{"id":49491341,"name":"CEAforArcGIS","full_name":"architecture-building-systems/CEAforArcGIS","owner":{"login":"architecture-building-systems","id":8478952,"avatar_url":"https://avatars3.githubusercontent.com/u/8478952?v=3","gravatar_id":"","url":"https://api.github.com/users/architecture-building-systems","html_url":"https://github.com/architecture-building-systems","followers_url":"https://api.github.com/users/architecture-building-systems/followers","following_url":"https://api.github.com/users/architecture-building-systems/following{/other_user}","gists_url":"https://api.github.com/users/architecture-building-systems/gists{/gist_id}","starred_url":"https://api.github.com/users/architecture-building-systems/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/architecture-building-systems/subscriptions","organizations_url":"https://api.github.com/users/architecture-building-systems/orgs","repos_url":"https://api.github.com/users/architecture-building-systems/repos","events_url":"https://api.github.com/users/architecture-building-systems/events{/privacy}","received_events_url":"https://api.github.com/users/architecture-building-systems/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/architecture-building-systems/CEAforArcGIS","description":"The City Energy Analyst (CEA)","fork":false,"url":"https://api.github.com/repos/architecture-building-systems/CEAforArcGIS","forks_url":"https://api.github.com/repos/architecture-building-systems/CEAforArcGIS/forks","keys_url":"https://api.github.com/repos/architecture-building-systems/CEAforArcGIS/keys{/key_id}","collaborators_url":"https://api.github.com/repos/architecture-building-systems/CEAforArcGIS/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/architecture-building-systems/CEAforArcGIS/teams","hooks_url":"https://api.github.com/repos/architecture-building-systems/CEAforArcGIS/hooks","issue_events_url":"https://api.github.com/repos/architecture-building-systems/CEAforArcGIS/issues/events{/number}","events_url":"https://api.github.com/repos/architecture-building-systems/CEAforArcGIS/events","assignees_url":"https://api.github.com/repos/architecture-building-systems/CEAforArcGIS/assignees{/user}","branches_url":"https://api.github.com/repos/architecture-building-systems/CEAforArcGIS/branches{/branch}","tags_url":"https://api.github.com/repos/architecture-building-systems/CEAforArcGIS/tags","blobs_url":"https://api.github.com/repos/architecture-building-systems/CEAforArcGIS/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/architecture-building-systems/CEAforArcGIS/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/architecture-building-systems/CEAforArcGIS/git/refs{/sha}","trees_url":"https://api.github.com/repos/architecture-building-systems/CEAforArcGIS/git/trees{/sha}","statuses_url":"https://api.github.com/repos/architecture-building-systems/CEAforArcGIS/statuses/{sha}","languages_url":"https://api.github.com/repos/architecture-building-systems/CEAforArcGIS/languages","stargazers_url":"https://api.github.com/repos/architecture-building-systems/CEAforArcGIS/stargazers","contributors_url":"https://api.github.com/repos/architecture-building-systems/CEAforArcGIS/contributors","subscribers_url":"https://api.github.com/repos/architecture-building-systems/CEAforArcGIS/subscribers","subscription_url":"https://api.github.com/repos/architecture-building-systems/CEAforArcGIS/subscription","commits_url":"https://api.github.com/repos/architecture-building-systems/CEAforArcGIS/commits{/sha}","git_commits_url":"https://api.github.com/repos/architecture-building-systems/CEAforArcGIS/git/commits{/sha}","comments_url":"https://api.github.com/repos/architecture-building-systems/CEAforArcGIS/comments{/number}","issue_comment_url":"https://api.github.com/repos/architecture-building-systems/CEAforArcGIS/issues/comments{/number}","contents_url":"https://api.github.com/repos/architecture-building-systems/CEAforArcGIS/contents/{+path}","compare_url":"https://api.github.com/repos/architecture-building-systems/CEAforArcGIS/compare/{base}...{head}","merges_url":"https://api.github.com/repos/architecture-building-systems/CEAforArcGIS/merges","archive_url":"https://api.github.com/repos/architecture-building-systems/CEAforArcGIS/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/architecture-building-systems/CEAforArcGIS/downloads","issues_url":"https://api.github.com/repos/architecture-building-systems/CEAforArcGIS/issues{/number}","pulls_url":"https://api.github.com/repos/architecture-building-systems/CEAforArcGIS/pulls{/number}","milestones_url":"https://api.github.com/repos/architecture-building-systems/CEAforArcGIS/milestones{/number}","notifications_url":"https://api.github.com/repos/architecture-building-systems/CEAforArcGIS/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/architecture-building-systems/CEAforArcGIS/labels{/name}","releases_url":"https://api.github.com/repos/architecture-building-systems/CEAforArcGIS/releases{/id}","deployments_url":"https://api.github.com/repos/architecture-building-systems/CEAforArcGIS/deployments","created_at":"2016-01-12T10:02:17Z","updated_at":"2017-04-10T07:56:52Z","pushed_at":"2017-05-10T09:42:13Z","git_url":"git://github.com/architecture-building-systems/CEAforArcGIS.git","ssh_url":"git@github.com:architecture-building-systems/CEAforArcGIS.git","clone_url":"https://github.com/architecture-building-systems/CEAforArcGIS.git","svn_url":"https://github.com/architecture-building-systems/CEAforArcGIS","homepage":"","size":227019,"stargazers_count":8,"watchers_count":8,"language":"Python","has_issues":true,"has_projects":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":3,"mirror_url":null,"open_issues_count":135,"forks":3,"open_issues":135,"watchers":8,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/architecture-building-systems/CEAforArcGIS/pulls/624"},"html":{"href":"https://github.com/architecture-building-systems/CEAforArcGIS/pull/624"},"issue":{"href":"https://api.github.com/repos/architecture-building-systems/CEAforArcGIS/issues/624"},"comments":{"href":"https://api.github.com/repos/architecture-building-systems/CEAforArcGIS/issues/624/comments"},"review_comments":{"href":"https://api.github.com/repos/architecture-building-systems/CEAforArcGIS/pulls/624/comments"},"review_comment":{"href":"https://api.github.com/repos/architecture-building-systems/CEAforArcGIS/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/architecture-building-systems/CEAforArcGIS/pulls/624/commits"},"statuses":{"href":"https://api.github.com/repos/architecture-building-systems/CEAforArcGIS/statuses/ca76c89255c1e7960f6a4a7072359d0ba7554303"}}}}
{"actor":{"display_login":"JIMENOFONSECA"}}