Developer procedures

Summary

This page describes some procedures related to Framesoc maintenance.

Update Framesoc website

Framesoc website is automatically generated by using the GitHub page generators and taking the README.md as input. To update the website the procedure is the following:

• Update the file README.md, commit and push it on Framesoc repository.
• From the Settings page, go to the Automatic page generator.
• Press the Load README.md button to load the README.md content.
• Press Continue to layouts and chose the Slate layout.
• Press Publish Page.

Note: to change the existing images (or add new images or other kind of resources), you have to add them on the gh-pages branch of Framesoc repository. This branch contains the actual website content. In the README.md you will have to use the whole url of these resources.

Create a new wiki page

When you add a new page to the Framesoc wiki, you have to update the wiki sidebar as well. Therefore, the procedure to follow is:

• Create the new page.
• Update the sidebar, adding the new page to the right section.

Release Framesoc

Releasing Framesoc means uploading a new version of the soctrace-inria update site and creating a new GitHub release. This section describes the procedure to do all of this.

Requirements

Your clones of framesoc and soctrace-inria.github.io repositories must be in the same root directory.

For example:

./somedir/framesoc
./somedir/soctrace-inria.github.io

Update site creation and upload

• Go to ./somedir/framesoc/src/fr.inria.soctrace.maven.master/

• Change the version using a command similar to the following:

./change_framesoc_version.sh 1.2.3

Note that the version must have the format x.y.z.

• If all is OK, commit and push the modifications related to the new version number.

• Build Framesoc.

./maven_build.sh

• If all is OK, upload the generated update site.

./upload_framesoc.sh 

Making a GitHub release

• Go to the Framesoc release page.
• Press Draft a new release.
• In the Tag version text field, specify the version tag in the format vx.y.z, where x.y.z must be the same as before.
• In the Release title text field, specify the version name using the format version x.y.z, where x.y.z must be the same as before.
• Optionally describe the release.
• Press Publish Release.

Note: this procedure only releases Framesoc. To release also Framesoc Importers, please refer to this page.

Development workflow management

Internal contributions

• The development tasks planned for Framesoc are described as GitHub issues.
• Different issues are grouped into milestones.
• Milestones correspond to new releases.
• Milestone names are the same as the tag that will be use for the GitHub release (e.g., vx.y.z).
• The development of each issue is done in a specific branch of the master. For example, the issue #106 could be managed on a branch named issue106-metadata.
• Only when the issue is closed and the code tested enough, the issue branch is merged into the master and the branch is deleted.
• The master should always contain a stable version.
• When all the issues of the milestone are closed, we can close the milestone and make a release.

External contributions

External contributions (contributions from people not belonging to the soctrace-inria team) will follow the normal GitHub fork/pull-request procedure.