From eb4eed7c8550ee78fb277f6301e43a923a487841 Mon Sep 17 00:00:00 2001 From: Amigo <49749100+aamigo@users.noreply.github.com> Date: Wed, 25 Sep 2019 07:26:25 +0200 Subject: [PATCH] Updated 062 Add your own JCB packages to the JCB Communty Directory (markdown) --- ...-packages-to-the-JCB-Communty-Directory.md | 21 +++++++++++++++++-- 1 file changed, 19 insertions(+), 2 deletions(-) diff --git a/062-Add-your-own-JCB-packages-to-the-JCB-Communty-Directory.md b/062-Add-your-own-JCB-packages-to-the-JCB-Communty-Directory.md index 59c1748..35d8fde 100644 --- a/062-Add-your-own-JCB-packages-to-the-JCB-Communty-Directory.md +++ b/062-Add-your-own-JCB-packages-to-the-JCB-Communty-Directory.md @@ -80,5 +80,22 @@ I'm going to go run the file and you can see what it does. You add the dot, make [00:16:33](https://www.youtube.com/watch?v=8FplwKKa708&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h16m33s) -???? -If you again do the 'git status', you'll see that there are 3 files that are not been tracked, and the checksum.json file has been modified. Why? because there is a new line been added to checksum.json. If we type in 'git diff', you'll see that your component, the one that you are adding, is being added. That line was changed because it have a comma. But this is the new line that has been added. So basically just added your component To the check some [00:17:15](https://www.youtube.com/watch?v=8FplwKKa708&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h17m15s) And that is all that should change You shouldn't change any other files In the repository Only the ones that you are contributing Are the ones that you must change Ok so There we go The next thing is to git Add Those files [00:17:34](https://www.youtube.com/watch?v=8FplwKKa708&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h17m34s) So if you do git Status They are now green now the comment The comment I think We there's like Convention out there I'm not so keyed up all that So the moment I think we can do Git [00:17:53](https://www.youtube.com/watch?v=8FplwKKa708&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h17m53s) Then Add it Questions and answers package I think that's simple enough And then Press enter Oops I left out something and it's to commit word So she say git commit Then a m The m is for the message in the a is for pushing it all into the branch So there we go and then you have if you have a pass phrase [00:18:21](https://www.youtube.com/watch?v=8FplwKKa708&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h18m21s) and you Which I should actually have Then there you have your commit signed If you don't know how to sign commits in git then please Google that and get your keys in place We would expect that all commits to this repo Be signed Specially since we need to be sure That it is you That am you know making the commit Now when you've done all that you do git [00:18:49](https://www.youtube.com/watch?v=8FplwKKa708&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h18m49s) And your push it up To your repository on GitHub At this point you are still not affecting the community repository It is just affecting The the repository that you forked And That is This is a very secure way of dealing with this So if we now go back to Git Hub [00:19:11](https://www.youtube.com/watch?v=8FplwKKa708&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h19m11s) And you know were fetch the page You see that I'll say this branch is one commit ahead of VDM And then there is this make a pull request So you make a pull request there And it will basically take you To the main repository And all explain to you which one is being pulled where and it will tell you that it is able to be merged And Did this is the information that's being added For the info [00:19:40](https://www.youtube.com/watch?v=8FplwKKa708&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h19m40s) For the sha And obviously for the package which it doesn't show because it's too big So you see Binary file not shown there it is And so there is also the changes to the checksum Now at this point You need to Create a pull request to click on create pull request And This [00:20:02](https://www.youtube.com/watch?v=8FplwKKa708&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h20m02s) Comment that you made in your repository when you you know Contributed the package would usually be added as the title You wanna give a little explanation of things that we as the admin team need to have dissipate Because we got obviously have to test this now We can't add packages to the community packets branch without being able to test it So if you have a key for the package Then Yes I think we will create a form Eventually [00:20:35](https://www.youtube.com/watch?v=8FplwKKa708&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h20m35s) Where you will be able to submit that And we'll put that in the information because at the moment this area doesn't even have a pull request template So we will add a pull request template So that when you create a pull request that tells you where to send the key Set the moment if there's a pull request maybe just keep the packages coming that are free at the moment as soon as the templates in place then then you can use it And then make a pull request And Then I'm at the moment the only one that [00:21:07](https://www.youtube.com/watch?v=8FplwKKa708&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h21m07s) Manage this but I hope that others would get involved There are some other developers already Quite involved on the JCB Repository But I would like to also encourage them to get involved here And be able to sort of help me Test these packages Make sure that only valid in Stable packages gets Added [00:21:30](https://www.youtube.com/watch?v=8FplwKKa708&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h21m30s) And so That's really it here you now click create pull request now I'm gonna do this Because it's all premature I I want to I don't wanna pull this into this The repository at the stage I'm gonna do so later But the point is This is the procedure that you need to follow To actually get a package into the community packages [00:21:58](https://www.youtube.com/watch?v=8FplwKKa708&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h21m58s) Because once it's get merged into the master branch It will also become available on this page Automatically So automatically it'll show up in this dropdown In fact That is a simple as it is Well thanks for watching and if you have any questions please open a issue At the correct place So if you wanna talk about the packages for the community Open issue here [00:22:27](https://www.youtube.com/watch?v=8FplwKKa708&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h22m27s) Please don't make a open issues at JCBs repository regarding this issue So that we'll have you know clear Separation Between these two concepts. Ok thanks for watching. +If you again do the 'git status', you'll see that there are 3 files that are not been tracked, and the checksum.json file has been modified. Why? because there is a new line been added to checksum.json. If we type in 'git diff', you'll see that your component, the one that you are adding, is being added. That line was changed because it have a comma. But this is the new line that has been added. Add your component to the checksum.json. [00:17:15](https://www.youtube.com/watch?v=8FplwKKa708&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h17m15s) That is all that should change. You shouldn't change any other files in the repository. Only the ones that you are contributing are the ones that you must change. + +### git Add The Files - Comment - git commit am"Added Questions And Answers Packages + +[00:17:30](https://www.youtube.com/watch?v=8FplwKKa708&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h17m30s) + +The next thing is to git add those files. Do git status, the words are now green. The comment, there's a lot of convention out there, I'm not keyed up with all of that. We can do [00:17:53](https://www.youtube.com/watch?v=8FplwKKa708&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h17m53s) 'git commit am"Added questions and answers package'. That's simple enough and then press enter. The m is for the message in the a is for pushing it all into the branch. If you have a pass phrase [00:18:21](https://www.youtube.com/watch?v=8FplwKKa708&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h18m21s) which you should have, then you have your commit signed. If you don't know how to sign commits in git then please Google that and get your keys in place. We would expect that all commits to this repo be signed. Especially since we need to be sure that it is you that are making the commit. + +### When All Is Done - git push To Your Repository On Github + +[00:18:46](https://www.youtube.com/watch?v=8FplwKKa708&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h18m46s) + +Now when you've done all that you do 'git' and you will push it up to your repository on GitHub. At this point you are still not affecting the community repository. It is just affecting the repository that you forked. This is a very secure way of dealing with this. If we now go back to GitHub [00:19:11](https://www.youtube.com/watch?v=8FplwKKa708&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h19m11s) were we fetch the page, you will see that it'll say this branch is one commit ahead of VDM. There is make a Pull Request. You will make a Pull Request and it will take you to the main repository and will explain to you which one is being pulled where and it will tell you that it is able to be merged. The information is being added for the info [00:19:40](https://www.youtube.com/watch?v=8FplwKKa708&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h19m40s) for the sha. and for the package which doesn't show because it's too big. You will see Binary file not shown. There is also the changes to the checksum.json. + +### Create A Pull Request + +[00:19:54](https://www.youtube.com/watch?v=8FplwKKa708&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h19m54s) + +Now at this point you will need to create a pull request. Click on Create Pull Request. The comment that you made in your repository, when you contributed the package, would be added as the title. If you want to give a little explanation of things that the admin team need to have anticipate, because we have to test this. We can't add packages to the community packets branch without being able to test it. If you have a key for the package, we will create a form [00:20:35](https://www.youtube.com/watch?v=8FplwKKa708&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h20m35s) where you will be able to submit that. We'll put that in the information because at the moment this area doesn't even have a pull request template. We will add a pull request template, when you create a pull request, it will tell you where to send the key. At the moment if there's no pull request, keep the packages that are coming that are free at the moment. As soon as the templates is in place then you can use it and then make a pull request. At the moment I'm the only one that [00:21:07](https://www.youtube.com/watch?v=8FplwKKa708&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h21m07s) manage this. I hope that others would get involved. There are some other developers involved on the JCB Repository, but I would like to also encourage them to get involved, and be able to help me test these packages, make sure that only valid and stable packages gets added. [00:21:30](https://www.youtube.com/watch?v=8FplwKKa708&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h21m30s) Click Create pull request. I don't want to pull this into the repository at the stage. I'm going to do it later. This is the procedure that you need to follow to get a package into the community packages. [00:21:58](https://www.youtube.com/watch?v=8FplwKKa708&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h21m58s) Because once it's been merged into the master branch, it will also become available on this page automatically. Automatically it'll show up in the drop down. That is a simple as it is. If you have any questions please open a issue at the correct place. If you want to talk about the packages for the community, open the issue here. [00:22:27](https://www.youtube.com/watch?v=8FplwKKa708&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h22m27s) Please don't make a open issues at JCBs repository regarding this issue, so that we'll have a clear separation between these two concepts.