Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Protect master branch and use only pull request on it #9

Open
GiulioRomualdi opened this issue Jun 13, 2018 · 7 comments
Open

Protect master branch and use only pull request on it #9

GiulioRomualdi opened this issue Jun 13, 2018 · 7 comments

Comments

@GiulioRomualdi
Copy link
Member

GiulioRomualdi commented Jun 13, 2018

Currently, this repo is used only by @S-Dafarra and @GiulioRomualdi but, in the short time, it will be added inside the robotology-superbuild robotology/robotology-superbuild#55 so others users may be interested to use it and edit it.

In my opinion, we should force using pull requests, this can be ensured enabling GitHub branch restrictions for the branch master https://help.github.com/articles/enabling-branch-restrictions/

Using pull requests we can take the trace of the development of the code and, moreover, they are useful to inform others what we are trying to do.

In order to make this as clean as possible an issue_template.md and a pull_request_template.md files should be added.

Sorry if I am too punctilious 😳

what do you think @traversaro, @S-Dafarra ?

@traversaro
Copy link
Member

I totally agree.

@S-Dafarra
Copy link
Collaborator

Considering that right now only the three of us have push access and that lately I am pushing directly to master, I can conclude you want to prevent me from pushing directly there 😂. Thus, I think it is a good idea 😉

@GiulioRomualdi
Copy link
Member Author

I can conclude you want to prevent me from pushing directly there 😂

No 😉, it is also for me. Because I don't want to change the code under your feet 😄

@traversaro
Copy link
Member

It may be also a good eventually to setup a changelog and tag releases. I do not think we have guidelines for all the workflow, but it would make sense to write them.

@GiulioRomualdi
Copy link
Member Author

It should be also nice to use travis to autogenerate the documentation, I have tried to follow this tutorial but I have to add a new deploy key to this repository and I don't know if it is a good idea.

@traversaro
Copy link
Member

I think @diegoferigo is an expert on this. Personally I never liked generating the doxygen docs from travis because I was never been able to deal with the amount of configuration necessary. I have a few alternatives for that, but I think it would take a few weeks to set them up.

@diegoferigo
Copy link
Member

diegoferigo commented Jun 15, 2018

@GiulioRomualdi It is fairly easy to setup travis for pushing using tokens. Have a look here for a reference (this also deploys a mkdocs-based website, mind only doxygen sections).

This works fine if you have a CMake target that generates the documentation as robotology/how-to-export-cpp-library. Otherwise you can follow the guide you linked which contains a script, and replacing the ssh keys authentication (which is overcomplicated) with token authentication.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants