From cb9f103d2c9c3a969fdd18d6e83c5117c67bd5a4 Mon Sep 17 00:00:00 2001 From: Llewellyn van der Merwe Date: Tue, 13 Jul 2021 10:40:16 +0200 Subject: [PATCH] first commit --- .github/workflows/joomla4.0-dev-lang.yml | 46 +++ .github/workflows/keep-active.yml | 46 +++ .github/workflows/lang-joomla4.0-dev.yml | 46 +++ .github/workflows/test.yml | 42 ++ .gitignore | 2 + LICENSE | 340 +++++++++++++++++ README.md | 66 ++++ conf/example | 69 ++++ conf/joomla4.0-dev-lang | 42 ++ conf/lang-joomla4.0-dev | 46 +++ src/active.sh | 13 + src/sync.sh | 464 +++++++++++++++++++++++ 12 files changed, 1222 insertions(+) create mode 100644 .github/workflows/joomla4.0-dev-lang.yml create mode 100644 .github/workflows/keep-active.yml create mode 100644 .github/workflows/lang-joomla4.0-dev.yml create mode 100644 .github/workflows/test.yml create mode 100644 .gitignore create mode 100644 LICENSE create mode 100644 README.md create mode 100644 conf/example create mode 100644 conf/joomla4.0-dev-lang create mode 100644 conf/lang-joomla4.0-dev create mode 100755 src/active.sh create mode 100755 src/sync.sh diff --git a/.github/workflows/joomla4.0-dev-lang.yml b/.github/workflows/joomla4.0-dev-lang.yml new file mode 100644 index 0000000..6c4c860 --- /dev/null +++ b/.github/workflows/joomla4.0-dev-lang.yml @@ -0,0 +1,46 @@ +name: "Sync Joomla4.0-dev CMS Files to Core Language" + +on: + # run once per/day (uncommented until we are ready to run this) + # schedule: + # - cron: '4 28 * * *' + + # so we can manually run a sync also + workflow_dispatch: + +jobs: + build: + runs-on: [ubuntu-20.04] + steps: + # We use this approach to sign all commits + # Also to use basic git commands in the sync script + # with no further authentication needed + # see: https://github.com/vdm-io/github-user + - name: Setup gitHub User Details + # how to set secrets? + # see: https://docs.github.com/en/actions/reference/encrypted-secrets + env: + # The github username with access + GIT_USER: ${{ secrets.GIT_USER }} + # The github user email with access + GIT_EMAIL: ${{ secrets.GIT_EMAIL }} + # The name of the myprivatekeys.asc user + GPG_USER: ${{ secrets.GPG_USER }} + # gpg -a --export-secret-keys >myprivatekeys.asc + # The whole key file text from the above myprivatekeys.asc + # This key must be linked to the github user being used + GPG_KEY: ${{ secrets.GPG_KEY }} + # A id_ed25519 ssh private key liked to the github user account + # see: https://docs.github.com/en/github-ae@latest/github/authenticating-to-github/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent#generating-a-new-ssh-key + SSH_KEY: ${{ secrets.SSH_KEY }} + # A id_ed25519.pub ssh public key liked to the github user account + SSH_PUB: ${{ secrets.SSH_PUB }} + run: | + /bin/bash <(/bin/curl -s https://raw.githubusercontent.com/vdm-io/github-user/master/src/setup.sh) --gpg-key "$GPG_KEY" --gpg-user "$GPG_USER" --ssh-key "$SSH_KEY" --ssh-pub "$SSH_PUB" --git-user "$GIT_USER" --git-email "$GIT_EMAIL" + - name: Clone Sync Bot Repo + # this is the repo that does the work + run: | + /bin/git clone -b master --single-branch git@github.com:vdm-io/github-sync-bot.git bot + - name: Sync The Repo Files + run: | + /bin/bash ./bot/src/sync.sh --conf=bot/conf/joomla4.0-dev-lang diff --git a/.github/workflows/keep-active.yml b/.github/workflows/keep-active.yml new file mode 100644 index 0000000..0d1226d --- /dev/null +++ b/.github/workflows/keep-active.yml @@ -0,0 +1,46 @@ +name: "Keep the bot repository active!" + +on: + # run Thursday at 02:13 every week + schedule: + - cron: '13 2 * * THU' + # so we can manually update + workflow_dispatch: + +jobs: + build: + runs-on: [ubuntu-20.04] + steps: + # We use this approach to sign all commits + # Also to use basic git commands in the sync script + # with no further authentication needed + # see: https://github.com/vdm-io/github-user + - name: Setup gitHub User Details + # how to set secrets? + # see: https://docs.github.com/en/actions/reference/encrypted-secrets + env: + # The github username with access + GIT_USER: ${{ secrets.GIT_USER }} + # The github user email with access + GIT_EMAIL: ${{ secrets.GIT_EMAIL }} + # The name of the myprivatekeys.asc user + GPG_USER: ${{ secrets.GPG_USER }} + # gpg -a --export-secret-keys >myprivatekeys.asc + # The whole key file text from the above myprivatekeys.asc + # This key must be linked to the github user being used + GPG_KEY: ${{ secrets.GPG_KEY }} + # A id_ed25519 ssh private key liked to the github user account + # see: https://docs.github.com/en/github-ae@latest/github/authenticating-to-github/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent#generating-a-new-ssh-key + SSH_KEY: ${{ secrets.SSH_KEY }} + # A id_ed25519.pub ssh public key liked to the github user account + SSH_PUB: ${{ secrets.SSH_PUB }} + run: | + /bin/bash <(/bin/curl -s https://raw.githubusercontent.com/vdm-io/github-user/master/src/setup.sh) --gpg-key "$GPG_KEY" --gpg-user "$GPG_USER" --ssh-key "$SSH_KEY" --ssh-pub "$SSH_PUB" --git-user "$GIT_USER" --git-email "$GIT_EMAIL" + - name: Clone Bot Repo + # this is the repo that does the work + run: | + /bin/git clone -b master --single-branch git@github.com:vdm-io/github-sync-bot.git bot + - name: Set Active + run: | + cd bot + /bin/bash ./src/active.sh \ No newline at end of file diff --git a/.github/workflows/lang-joomla4.0-dev.yml b/.github/workflows/lang-joomla4.0-dev.yml new file mode 100644 index 0000000..fab750e --- /dev/null +++ b/.github/workflows/lang-joomla4.0-dev.yml @@ -0,0 +1,46 @@ +name: "Sync Core Language Files to Joomla4.0-dev CMS" + +on: + # run once per/day (uncommented until we are ready to run this) + # schedule: + # - cron: '3 29 * * *' + + # so we can manually run a sync also + workflow_dispatch: + +jobs: + build: + runs-on: [ubuntu-20.04] + steps: + # We use this approach to sign all commits + # Also to use basic git commands in the sync script + # with no further authentication needed + # see: https://github.com/vdm-io/github-user + - name: Setup gitHub User Details + # how to set secrets? + # see: https://docs.github.com/en/actions/reference/encrypted-secrets + env: + # The github username with access + GIT_USER: ${{ secrets.GIT_USER }} + # The github user email with access + GIT_EMAIL: ${{ secrets.GIT_EMAIL }} + # The name of the myprivatekeys.asc user + GPG_USER: ${{ secrets.GPG_USER }} + # gpg -a --export-secret-keys >myprivatekeys.asc + # The whole key file text from the above myprivatekeys.asc + # This key must be linked to the github user being used + GPG_KEY: ${{ secrets.GPG_KEY }} + # A id_ed25519 ssh private key liked to the github user account + # see: https://docs.github.com/en/github-ae@latest/github/authenticating-to-github/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent#generating-a-new-ssh-key + SSH_KEY: ${{ secrets.SSH_KEY }} + # A id_ed25519.pub ssh public key liked to the github user account + SSH_PUB: ${{ secrets.SSH_PUB }} + run: | + /bin/bash <(/bin/curl -s https://raw.githubusercontent.com/vdm-io/github-user/master/src/setup.sh) --gpg-key "$GPG_KEY" --gpg-user "$GPG_USER" --ssh-key "$SSH_KEY" --ssh-pub "$SSH_PUB" --git-user "$GIT_USER" --git-email "$GIT_EMAIL" + - name: Clone Sync Bot Repo + # this is the repo that does the work + run: | + /bin/git clone -b master --single-branch git@github.com:vdm-io/github-sync-bot.git bot + - name: Sync The Repo Files + run: | + /bin/bash ./bot/src/sync.sh --conf=bot/conf/lang-joomla4.0-dev diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml new file mode 100644 index 0000000..1d1533d --- /dev/null +++ b/.github/workflows/test.yml @@ -0,0 +1,42 @@ +name: "Test Sync Bot" + + # so we can manually run a sync test + workflow_dispatch: + +jobs: + build: + runs-on: [ubuntu-20.04] + steps: + # We use this approach to sign all commits + # Also to use basic git commands in the sync script + # with no further authentication needed + # see: https://github.com/vdm-io/github-user + - name: Setup gitHub User Details + # how to set secrets? + # see: https://docs.github.com/en/actions/reference/encrypted-secrets + env: + # The github username with access + GIT_USER: ${{ secrets.GIT_USER }} + # The github user email with access + GIT_EMAIL: ${{ secrets.GIT_EMAIL }} + # The name of the myprivatekeys.asc user + GPG_USER: ${{ secrets.GPG_USER }} + # gpg -a --export-secret-keys >myprivatekeys.asc + # The whole key file text from the above myprivatekeys.asc + # This key must be linked to the github user being used + GPG_KEY: ${{ secrets.GPG_KEY }} + # A id_ed25519 ssh private key liked to the github user account + # see: https://docs.github.com/en/github-ae@latest/github/authenticating-to-github/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent#generating-a-new-ssh-key + SSH_KEY: ${{ secrets.SSH_KEY }} + # A id_ed25519.pub ssh public key liked to the github user account + SSH_PUB: ${{ secrets.SSH_PUB }} + run: | + /bin/bash <(/bin/curl -s https://raw.githubusercontent.com/vdm-io/github-user/master/src/setup.sh) --gpg-key "$GPG_KEY" --gpg-user "$GPG_USER" --ssh-key "$SSH_KEY" --ssh-pub "$SSH_PUB" --git-user "$GIT_USER" --git-email "$GIT_EMAIL" + - name: Clone Sync Bot Repo + # this is the repo that does the work + run: | + /bin/git clone -b master --single-branch git@github.com:vdm-io/github-sync-bot.git bot + - name: Sync The Repo Files + run: | + /bin/bash ./bot/src/sync.sh --conf=bot/conf/joomla4.0-dev-lang --test + /bin/bash ./bot/src/sync.sh --conf=bot/conf/lang-joomla4.0-dev --test \ No newline at end of file diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..c6ef218 --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +.idea + diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..1f963da --- /dev/null +++ b/LICENSE @@ -0,0 +1,340 @@ + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Lesser General Public License instead.) You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +this service if you wish), that you receive source code or can get it +if you want it, that you can change the software or use pieces of it +in new free programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must show them these terms so they know their +rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute verbatim copies of the Program's +source code as you receive it, in any medium, provided that you +conspicuously and appropriately publish on each copy an appropriate +copyright notice and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a fee. + + 2. You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of Sections + 1 and 2 above on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance. + + 5. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + + 7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 9. The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED +OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS +TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + + 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING +OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED +TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY +YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License along + with this program; if not, write to the Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, the commands you use may +be called something other than `show w' and `show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + `Gnomovision' (which makes passes at compilers) written by James Hacker. + + , 1 April 1989 + Ty Coon, President of Vice + +This General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may +consider it more useful to permit linking proprietary applications with the +library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. + diff --git a/README.md b/README.md new file mode 100644 index 0000000..539fb2d --- /dev/null +++ b/README.md @@ -0,0 +1,66 @@ +## Github Sync Bot Setup + +- We use this script to setup a github user on the Ubuntu systems in the Github Actions Workflows. See setup instructions below. +- Then the sync of each set of repositories are manage with a config file found in the conf folder. +- So we have to setup multiple workflows for each set repositories (config) you would like to sync. + +### How To SETUP gitHub User + +You will need to setup a list of secrets in your account. You can do this per/repository or per/organization. + +> The github user email being used to build +- GIT_EMAIL + +> The github username being used to build +- GIT_USER + +> gpg -a --export-secret-keys >myprivatekeys.asc +> The whole key file text from the above myprivatekeys.asc +> This key must be linked to the github user being used +- GPG_KEY + +> The name of the myprivatekeys.asc user +- GPG_USER + +> A id_ed25519 ssh private key liked to the github user account +- SSH_KEY + +> A id_ed25519.pub ssh public key liked to the github user account +- SSH_PUB + +All these secret values are needed to fully automate the setup to easily interact with gitHub. + +### Workflows + +In your workflows action script you will need to add the following as an example: + +```yaml +jobs: + build: + runs-on: [ubuntu-20.04] + steps: + - name: Setup gitHub User Details + env: + GIT_USER: ${{ secrets.GIT_USER }} + GIT_EMAIL: ${{ secrets.GIT_EMAIL }} + GPG_USER: ${{ secrets.GPG_USER }} + GPG_KEY: ${{ secrets.GPG_KEY }} + SSH_KEY: ${{ secrets.SSH_KEY }} + SSH_PUB: ${{ secrets.SSH_PUB }} + run: | + /bin/bash <(/bin/curl -s https://raw.githubusercontent.com/vdm-io/github-user/master/src/setup.sh) --gpg-key "$GPG_KEY" --gpg-user "$GPG_USER" --ssh-key "$SSH_KEY" --ssh-pub "$SSH_PUB" --git-user "$GIT_USER" --git-email "$GIT_EMAIL" + - name: Clone Sync Bot Repo + # this is the repo that does the work + run: | + /bin/git clone -b master --single-branch git@github.com:[org]/github-sync-bot.git bot + - name: Sync The Repo Files + run: | + cd bot + /bin/bash ./src/sync.sh --conf=./conf/[config] +``` + +### Free Software License +```txt +@copyright Copyright (C) 2021 Llewellyn van der Merwe. All rights reserved. +@license GNU General Public License version 2 or later; see LICENSE.txt +``` diff --git a/conf/example b/conf/example new file mode 100644 index 0000000..86363f8 --- /dev/null +++ b/conf/example @@ -0,0 +1,69 @@ +####################################################################################################### +# The Configuration File +# You must update each value as needed (defaults do not work) +# All values required, except source[dot]repo[dot]files (omitting that will sync all files in folders) +####################################################################################################### + +# set the source repo path +source.repo.path=org/repo + +# set the source repo branch +source.repo.branch=main + +# set the source repo folders +# separate multiple paths with a semicolon +# paths as seen from repo root +# each path will require the same number(position) path in the target[dot]repo[dot]folders +# so that the following will be true: +# source[dot]repo[dot]folders=folder/path_a;folder/path_b +# maps<->to +# target[dot]repo[dot]folders=folder/another/path_a;folder/path_b +source.repo.folders=folder/path_a;folder/path_b + +# set the source repo files (not required) +# omitting this will sync all files in the folders +# separate multiple folders files with a semicolon +# separate multiple files in a folder with a comma +# each set of files will require the same number(position) path in the source[dot]repo[dot]folders +# setting a 0 in a position will allow all files & sub-folders of that folder to be synced +# setting a 1 in a position will allow only all files in that folder to be synced +# setting a 2 in a position will allow only all sub-folders in that folder to be synced +# +# so that the following will be true: +# source[dot]repo[dot]folders=folder/path_a;folder/path_b;folder/path_c +# maps<->to +# source[dot]repo[dot]files=0;a-file.js,b-file.js,sub-folder/file.html;the-file-in-folder-c.php +# folder 0=folder/path_a all files and folders are synced +# folder 1=folder/path_b only three files are synced (a-file.js and b-file.js and sub-folder/file.html) +# folder 2=folder/path_c only one file is synced (the-file-in-folder-c.php) +source.repo.files=0;a-file.js,b-file.js + +####################################################################################################### + +# set the target repo path +target.repo.path=org1/repo1 + +# set the target repo branch +target.repo.branch=master + +# set the target repo folders +# separate multiple paths with a semicolon +# paths as seen from repo root +# each path will require the same number(position) path in the source[dot]repo[dot]folders +# so that the following will be true: +# target[dot]repo[dot]folders=folder/another/path_a;folder/path_b +# maps<->to +# source[dot]repo[dot]folders=folder/path_a;folder/path_b +target.repo.folders=folder/path_a;folder/path_b + +# To merge or just make a PR (0 = PR; 1 = Merge) +target.repo.merge=1 + +# Target fork is rebased (if out of sync with upstream target) +# Then updated and used to make a PR or Merge +target.repo.fork=org2/repo2 + +####################################################################################################### +# To deactivate a value remove the dot +# example: source[dot]repo +####################################################################################################### \ No newline at end of file diff --git a/conf/joomla4.0-dev-lang b/conf/joomla4.0-dev-lang new file mode 100644 index 0000000..0d257cb --- /dev/null +++ b/conf/joomla4.0-dev-lang @@ -0,0 +1,42 @@ +####################################################################################################### +# The Configuration File to move Joomla 4.0 files to core_translation +####################################################################################################### + +# set the source repo path +source.repo.path=joomla/joomla-cms + +# set the source repo branch +source.repo.branch=4.0-dev + +# set the source repo folders +# separate multiple paths with a semicolon +# paths as seen from repo root +# each path will require the same number(position) path in the target[dot]repo[dot]folders +# so that the following will be true: +# source[dot]repo[dot]folders=folder/path_a;folder/path_b +# maps<->to +# target[dot]repo[dot]folders=folder/another/path_a;folder/path_b +source.repo.folders=language/en-GB;administrator/language/en-GB;api/language/en-GB + +####################################################################################################### + +# set the target repo path +target.repo.path=joomla/core-translations + +# set the target repo branch +target.repo.branch=main + +# set the target repo folders +# separate multiple paths with a semicolon +# paths as seen from repo root +# each path will require the same number(position) path in the source[dot]repo[dot]folders +# so that the following will be true: +# target[dot]repo[dot]folders=folder/another/path_a;folder/path_b +# maps<->to +# source[dot]repo[dot]folders=folder/path_a;folder/path_b +target.repo.folders=joomla_v4/source/language/en-GB;joomla_v4/source/administrator/language/en-GB;joomla_v4/source/api/language/en-GB + +# To merge or just make a PR (0 = PR; 1 = Merge) +target.repo.merge=1 + +####################################################################################################### \ No newline at end of file diff --git a/conf/lang-joomla4.0-dev b/conf/lang-joomla4.0-dev new file mode 100644 index 0000000..633205e --- /dev/null +++ b/conf/lang-joomla4.0-dev @@ -0,0 +1,46 @@ +####################################################################################################### +# The Configuration File to move core_translation files to Joomla 4.0 +####################################################################################################### + +# set the source repo path +source.repo.path=joomla/core-translations + +# set the source repo branch +source.repo.branch=main + +# set the source repo folders +# separate multiple paths with a semicolon +# paths as seen from repo root +# each path will require the same number(position) path in the target[dot]repo[dot]folders +# so that the following will be true: +# source[dot]repo[dot]folders=folder/path_a;folder/path_b +# maps<->to +# target[dot]repo[dot]folders=folder/another/path_a;folder/path_b +source.repo.folders=joomla_v4/translations/core/installation/language/en-GB;joomla_v4/translations/core/build/media_source/system/js/fields/calendar-locales + +####################################################################################################### + +# set the target repo path +target.repo.path=joomla/joomla-cms + +# set the target repo branch +target.repo.branch=4.0-dev + +# set the target repo folders +# separate multiple paths with a semicolon +# paths as seen from repo root +# each path will require the same number(position) path in the source[dot]repo[dot]folders +# so that the following will be true: +# target[dot]repo[dot]folders=folder/another/path_a;folder/path_b +# maps<->to +# source[dot]repo[dot]folders=folder/path_a;folder/path_b +target.repo.folders=installation/language/en-GB;build/media_source/system/js/fields/calendar-locales + +# To merge or just make a PR (0 = PR; 1 = Merge) +target.repo.merge=0 + +# Target fork is rebased (if out of sync with upstream target) +# Then updated and used to make a PR or Merge +target.repo.fork=llewellynvdm/joomla-cms + +####################################################################################################### \ No newline at end of file diff --git a/src/active.sh b/src/active.sh new file mode 100755 index 0000000..33451d3 --- /dev/null +++ b/src/active.sh @@ -0,0 +1,13 @@ +#!/bin/bash + +# must keep the repo active or all actions will stop running after 60 days +# use UTC+00:00 time also called zulu +TODAY=$(TZ=":ZULU" date '+%A %d-%B, %Y') + +echo "${TODAY}" > .active + +git add . +git commit -am"active on ${TODAY}" +git push + +exit 0 \ No newline at end of file diff --git a/src/sync.sh b/src/sync.sh new file mode 100755 index 0000000..ad4b2c6 --- /dev/null +++ b/src/sync.sh @@ -0,0 +1,464 @@ +#! /bin/bash + +# get start time +STARTBUILD=$(date +"%s") +# use UTC+00:00 time also called zulu +STARTDATE=$(TZ=":ZULU" date +"%m/%d/%Y @ %R (UTC)") +# main project Header +HEADERTITLE="Github Sync Bot v1.0" + +# main function ˘Ô≈ôﺣ +function main() { + # check that all needed values are set + checkConfValues + # clone all needed repos + cloneRepos + # move the files and folders + moveFoldersFiles + # now to add the merge or pull request part + # soon.... +} + +# show the configuration values +function checkConfValues () { + # check if we have found errors + local ERROR=0 + + # make sure SOURCE_REPO is set + [[ ! "${SOURCE_REPO}" == *"/"* ]] && echo "SOURCE_REPO:${SOURCE_REPO} is not a repo path!" && ERROR=1 + ! wget --spider "https://github.com/${SOURCE_REPO}" 2>/dev/null && \ + echo "SOURCE_REPO:https://github.com/${SOURCE_REPO} is not set correctly, or the guthub user does not have access!" && \ + ERROR=1 + + # make sure SOURCE_REPO_BRANCH is set + [ ${#SOURCE_REPO_BRANCH} -le 1 ] && echo "SOURCE_REPO_BRANCH:${SOURCE_REPO_BRANCH} is not set correctly!" && ERROR=1 + + # make sure SOURCE_REPO_FOLDERS is set + [ ${#SOURCE_REPO_FOLDERS} -le 1 ] && echo "SOURCE_REPO_FOLDERS:${SOURCE_REPO_FOLDERS} is not set correctly!" && ERROR=1 + + # make sure TARGET_REPO is set + [[ ! "${TARGET_REPO}" == *"/"* ]] && echo "TARGET_REPO:${TARGET_REPO} is not a repo path!" && ERROR=1 + ! wget --spider "https://github.com/${TARGET_REPO}" 2>/dev/null \ + && echo "TARGET_REPO:https://github.com/${TARGET_REPO} is not set correctly, or the guthub user does not have access!" \ + && ERROR=1 + + # make sure TARGET_REPO_BRANCH is set + [ ${#TARGET_REPO_BRANCH} -le 1 ] && echo "TARGET_REPO_BRANCH:${TARGET_REPO_BRANCH} is not set correctly!" && ERROR=1 + + # make sure TARGET_REPO_FOLDERS is set + [ ${#TARGET_REPO_FOLDERS} -le 1 ] && echo "TARGET_REPO_FOLDERS:${TARGET_REPO_FOLDERS} is not set correctly!" && ERROR=1 + + # check that the correct action is set + ! (("$TARGET_REPO_ACTION" == 1)) && ! (("$TARGET_REPO_ACTION" == 0)) && echo "TARGET_REPO_ACTION:${TARGET_REPO_ACTION} is not set correctly!" && ERROR=1 + + # make sure TARGET_REPO_FORK is set correctly if set + if [ ${#TARGET_REPO_FORK} -ge 1 ]; then + [[ ! "${TARGET_REPO_FORK}" == *"/"* ]] && echo "TARGET_REPO_FORK:${TARGET_REPO_FORK} is not a repo path!" && ERROR=1 + ! wget --spider "https://github.com/${TARGET_REPO_FORK}" 2>/dev/null \ + && echo "TARGET_REPO_FORK:https://github.com/${TARGET_REPO_FORK} is not set correctly, or the guthub user does not have access!" \ + && ERROR=1 + fi + + # if error found exit + (("$ERROR" == 1)) && exit 1 +} + +# clone the repo +function cloneRepos () { + # clone the source repo (we don't need access on this one) + [[ ! "${SOURCE_REPO}" == *"/"* ]] && cloneRepo "https://github.com/${SOURCE_REPO}.git" "${SOURCE_REPO_BRANCH}" "source_repo" + # clone the forked target repo if set + if [[ "${TARGET_REPO_FORK}" == *"/"* ]]; then + # we need access on this one, so we use git@github.com: + cloneRepo "${TARGET_REPO_FORK}" "git@github.com:${TARGET_REPO_BRANCH}.git" "target_repo" + # rebase with upstream if not in sync + rebaseWithUpstream "${TARGET_REPO}" "https://github.com/${TARGET_REPO_BRANCH}.git" "target_repo" + # we must have merge set if we directly work with target repo + elif (("$TARGET_REPO_ACTION" == 1)); then + # we need access on this one, so we use git@github.com: + cloneRepo "${TARGET_REPO}" "git@github.com:${TARGET_REPO_BRANCH}.git" "target_repo" + else + echo "You must set TARGET_REPO:${TARGET_REPO} to target.repo.merge=1 if no target.repo.fork is given!" + exit 1 + fi +} + +# clone the repo +function cloneRepo () { + # set local values + local git_repo="$1" + local git_branch="$2" + local git_folder="$3" + # clone the repo (but only a single branch) + git clone -b "$git_branch" --single-branch "$git_repo" "$git_folder" --quiet + if [ $? -eq 0 ];then + echo "${git_repo} was cloned successfully." + else + echo "${git_repo} failed to cloned successfully, check that the GitHub user has access to this repo!" + exit 1 + fi +} + +# rebase repo with its upstream (old school) +function rebaseWithUpstream () { + # current folder + local current_folder=$PWD + # set local values + local git_repo_upstream="$1" + local git_branch="$2" + local git_folder="$3" + # just a random remote name + local git_upstream="stroomOp" + # go into repo folder + cd ${git_folder} + # add the upstream repo + git remote add "$git_upstream" "$git_repo_upstream" --quiet + if [ $? -eq 0 ];then + echo "upstream:${git_repo_upstream} was added successfully." + else + echo "Failed to add upstream:${git_repo_upstream} successfully, check that the GitHub user has access to this repo!" + exit 1 + fi + # now fetch this upstream repo + git fetch "$git_upstream/${git_branch}" --quiet + if [ $? -eq 0 ];then + echo "upstream/${git_branch} was fetched successfully." + else + echo "Failed to fetch upstream/${git_branch} successfully, check that the GitHub user has access to this repo!" + exit 1 + fi + # make sure we ae on the targeted branch + git checkout "$git_branch" + # reset this branch to be same as upstream + git reset --hard "${git_upstream}/${git_branch}" --quiet + if [ $? -eq 0 ];then + echo "upstream:${git_repo_upstream} was rebased into the forked repo successfully." + else + echo "Failed to rebase upstream:${git_repo_upstream} successfully, check that the GitHub user has access to this repo!" + exit 1 + fi + # make sure this is not a test + if (("$TEST" == 1)); then + echo "The forked repo of upstream:${git_repo_upstream} not updated, as this is a test." + else + # force update the forked repo + git push origin "$git_branch" --force --quiet + if [ $? -eq 0 ];then + echo "The forked repo of upstream:${git_repo_upstream} successfully updated." + else + echo "Failed to update the forked repo, check that the GitHub user has access to this repo!" + exit 1 + fi + fi + # return to original folder + cd "${current_folder}" +} + +# move the source folders and files to the target folders +function moveFoldersFiles () { + # check if we have an array of folders + if [[ "${SOURCE_REPO_FOLDERS}" == *";"* ]] && [[ "${TARGET_REPO_FOLDERS}" == *";"* ]]; then + # set the folders array + IFS=';' read -ra source_folders <<<"${SOURCE_REPO_FOLDERS}" + IFS=';' read -ra target_folders <<<"${TARGET_REPO_FOLDERS}" + # check if we have files array + local has_files=0 + if [[ "${SOURCE_REPO_FILES}" == *";"* ]]; then + IFS=';' read -ra source_files <<<"${SOURCE_REPO_FILES}" + has_files=1 + fi + # now we loop over the source folder + for key in "${!source_folders[@]}"; do + # check that the target folder is set + if [ ${target_folders[key]+abc} ]; then + # check of we have files + if (("$has_files" == 1)); then + if [ ${source_files[key]+abc} ]; then + moveFolderFiles "${source_folders[key]}" "${target_folders[key]}" "${source_files[key]}" + else + echo "Source folder:${source_folders[key]} file mismatched!" + exit 1 + fi + # just move all the content of the folder + else + moveFolder "${source_folders[key]}" "${target_folders[key]}" + fi + else + echo "Source folder:${source_folders[key]} mismatched!" + exit 1 + fi + done + fi +} + +# move the source folder's 'files to the target folders +function moveFolderFiles () { + local source_folder="$1" + local target_folder="$2" + local source_files="${3:=0}" + # prep folders to have no trailing or leading forward slashes + source_folder="${source_folder%/}" + source_folder="${source_folder#/}" + target_folder="${target_folder%/}" + target_folder="${target_folder#/}" + # make sure the source folder exist + if [ ! -f "source_repo/${source_folder}" ]; then + echo "failed to copy [source_repo/${source_folder}/* -> target_repo/${target_folder}] since source folder does not exist. (failure)" + else + # make sure the target folder exist + if [ ! -f "target_repo/${target_folder}" ]; then + # create this folder if it does not exist + mkdir -p "target_repo/${target_folder}" + fi + # check if we have number command + re='^[0-9]+$' + if [[ "$source_files" =~ $re ]]; then + # 0 = all + if (("$source_files" == 0)); then + # copy both files and sub-folders recursive by force + cp -fr "source_repo/${source_folder}/*" "target_repo/${target_folder}" + if [ $? -eq 0 ]; then + echo "copied [source_repo/${source_folder}/* -> target_repo/${target_folder}] (success)" + else + echo "failed to copy [source_repo/${source_folder}/* -> target_repo/${target_folder}] (failure)" + fi + # 1 = only all files (no sub-folders) + elif (("$source_files" == 1)); then + # copy only the file by force + cp -f "source_repo/${source_folder}/*" "target_repo/${target_folder}" + if [ $? -eq 0 ]; then + echo "copied [source_repo/${source_folder}/* -> target_repo/${target_folder}] (success)" + else + echo "failed to copy [source_repo/${source_folder}/* -> target_repo/${target_folder}] (failure)" + fi + # 2 = only all sub-folders and their files + elif (("$source_files" == 2)); then + echo "This command:2 means to copy only all sub-folders and their files." + echo 'Yet this file command:${source_files} for source_repo/${source_folder} is not ready to be used... so nothing was copied!'; + # could be a file (name as number) so we try to copy it + else + # copy file/folder recursive by force + cp -fr "source_repo/${source_folder}/${source_files}" "target_repo/${target_folder}" + if [ $? -eq 0 ]; then + echo "copied [source_repo/${source_folder}/${source_files} -> target_repo/${target_folder}] (success)" + else + echo "failed to copy [source_repo/${source_folder}/${source_files} -> target_repo/${target_folder}] (failure)" + fi + fi + else + if [[ "${source_files}" == *","* ]]; then + # convert this to an array of files names + IFS=',' read -ra source_multi_files <<<"${source_files}" + # now we loop over the files + for file in "${source_multi_files[@]}"; do + # prep the file + file="${file%/}" + file="${file#/}" + # copy file/folder recursive by force + cp -fr "source_repo/${source_folder}/${file}" "target_repo/${target_folder}" + if [ $? -eq 0 ]; then + echo "copied [source_repo/${source_folder}/${file} -> target_repo/${target_folder}] (success)" + else + echo "failed to copy [source_repo/${source_folder}/${file} -> target_repo/${target_folder}] (failure)" + fi + done + else + # prep the file + source_files="${source_files%/}" + source_files="${source_files#/}" + # copy file/folder recursive by force + cp -fr "source_repo/${source_folder}/${source_files}" "target_repo/${target_folder}" + if [ $? -eq 0 ]; then + echo "copied [source_repo/${source_folder}/${source_files} -> target_repo/${target_folder}] (success)" + else + echo "failed to copy [source_repo/${source_folder}/${source_files} -> target_repo/${target_folder}] (failure)" + fi + fi + fi + fi +} + +# move the source folder and all content to the target folder +function moveFolder () { + local source_folder="$1" + local target_folder="$2" + # prep folders to have no trailing or leading forward slashes + source_folder="${source_folder%/}" + source_folder="${source_folder#/}" + target_folder="${target_folder%/}" + target_folder="${target_folder#/}" + # make sure the source folder exist + if [ ! -f "source_repo/${source_folder}" ]; then + echo "failed to copy [source_repo/${source_folder}/* -> target_repo/${target_folder}] since source folder does not exist. (failure)" + else + # make sure the target folder exist + if [ ! -f "target_repo/${target_folder}" ]; then + # create this folder if it does not exist + mkdir -p "target_repo/${target_folder}" + fi + # copy both files and sub-folders recursive by force + cp -fr "source_repo/${source_folder}/*" "target_repo/${target_folder}" + if [ $? -eq 0 ]; then + echo "copied [source_repo/${source_folder}/* -> target_repo/${target_folder}] (success)" + else + echo "failed to copy [source_repo/${source_folder}/* -> target_repo/${target_folder}] (failure)" + fi + fi +} + +# set any/all configuration values +function setConfValues() { + if [ -f $CONFIG_FILE ]; then + # set all configuration values + # see: conf/example (for details) + SOURCE_REPO=$(getConfVal "source\.repo\.path" "${SOURCE_REPO}") + SOURCE_REPO_BRANCH=$(getConfVal "source\.repo\.branch" "${SOURCE_REPO_BRANCH}") + SOURCE_REPO_FOLDERS=$(getConfVal "source\.repo\.folders" "${SOURCE_REPO_FOLDERS}") + SOURCE_REPO_FILES=$(getConfVal "source\.repo\.files" "${SOURCE_REPO_FILES}") + TARGET_REPO=$(getConfVal "target\.repo\.path" "${TARGET_REPO}") + TARGET_REPO_BRANCH=$(getConfVal "target\.repo\.branch" "${TARGET_REPO_BRANCH}") + TARGET_REPO_FOLDERS=$(getConfVal "target\.repo\.folders" "${TARGET_REPO_FOLDERS}") + # To merge or just make a PR (0 = PR; 1 = Merge) + TARGET_REPO_ACTION=$(getConfVal "target\.repo\.merge" "${TARGET_REPO_ACTION}") + # Target fork is rebased (if out of sync with upstream target) then updated and used to make a PR or Merge + TARGET_REPO_FORK=$(getConfVal "target\.repo\.fork" "${TARGET_REPO_FORK}") + fi +} + +# get default properties from config file +function getConfVal() { + local PROP_KEY="$1" + local PROP_VALUE=$(cat $CONFIG_FILE | grep "$PROP_KEY" | cut -d'=' -f2) + echo "${PROP_VALUE:-$2}" +} + +# show the configuration values +function showConfValues () { + echo "======================================================" + echo " ${HEADERTITLE}" + echo "======================================================" + echo "CONFIG_FILE: ${CONFIG_FILE}" + echo "TEST: ${TEST}" + echo "SOURCE_REPO: ${SOURCE_REPO}" + echo "SOURCE_REPO_BRANCH: ${SOURCE_REPO_BRANCH}" + echo "SOURCE_REPO_FOLDERS: ${SOURCE_REPO_FOLDERS}" + echo "SOURCE_REPO_FILES: ${SOURCE_REPO_FILES}" + echo "TARGET_REPO: ${TARGET_REPO}" + echo "TARGET_REPO_BRANCH: ${TARGET_REPO_BRANCH}" + echo "TARGET_REPO_FOLDERS: ${TARGET_REPO_FOLDERS}" + echo "TARGET_REPO_ACTION: ${TARGET_REPO_ACTION}" + echo "TARGET_REPO_FORK: ${TARGET_REPO_FORK}" + echo "======================================================" +} + +# help message ʕ•ᴥ•ʔ +function show_help() { + cat < + set all the config properties with a file + + properties examples are: + source.repo.path=[org]/[repo] + source.repo.branch=[branch] + source.repo.folders=[folder/path_a;folder/path_b] + source.repo.files=[0;a-file.js,b-file.js] + target.repo.path=[org]/[repo] + target.repo.branch=[branch] + target.repo.folders=[folder/path_a;folder/path_b] + # To merge or just make a PR (0 = PR; 1 = Merge) + target.repo.merge=1 + # Target fork is rebased (if out of sync with upstream target) then updated and used to make a PR or Merge + target.repo.fork=[org]/[repo] + see: conf/example + + example: ${0##*/:-} --conf=/home/$USER/.config/repos-to-sync.conf + ====================================================== + --test + activate the test behaviour + example: ${0##*/:-} --test + ====================================================== + --dry + To show all configuration, and not update repos + example: ${0##*/:-} --dry + ====================================================== + -h|--help + display this help menu + example: ${0##*/:-} -h + example: ${0##*/:-} --help + ====================================================== + ${HEADERTITLE} + ====================================================== +EOF +} + +# DEFAULTS/GLOBALS +CONFIG_FILE="" +TEST=0 +DRYRUN=0 + +# CONFIG VALUES +# see: conf/example (for details) +SOURCE_REPO="" +SOURCE_REPO_BRANCH="" +SOURCE_REPO_FOLDERS="" +SOURCE_REPO_FILES="" +TARGET_REPO="" +TARGET_REPO_BRANCH="" +TARGET_REPO_FOLDERS="" +TARGET_REPO_ACTION=0 # To merge or just make a PR (0 = PR; 1 = Merge) +TARGET_REPO_FORK="" # Target fork is rebased (if out of sync with upstream target) then updated and used to make a PR or Merge + +# check if we have options +while :; do + case $1 in + -h | --help) + show_help # Display a usage synopsis. + exit + ;; + --dry) + DRYRUN=1 + ;; + --test) # set the test behaviour + TEST=1 + ;; + --conf) # Takes an option argument; ensure it has been specified. + if [ "$2" ]; then + CONFIG_FILE=$2 + shift + else + echo 'ERROR: "--conf" requires a non-empty option argument.' + exit 1 + fi + ;; + --conf=?*) + CONFIG_FILE=${1#*=} # Delete everything up to "=" and assign the remainder. + ;; + --conf=) # Handle the case of an empty --conf= + echo 'ERROR: "--conf" requires a non-empty option argument.' + exit 1 + ;; + *) # Default case: No more options, so break out of the loop. + break ;; + esac + shift +done + +# We must have a config file +[ ! -f "${CONFIG_FILE}" ] && echo >&2 "The config:${CONFIG_FILE} is not set or found. Aborting." && exit 1 + +# set the configuration values +setConfValues + +# show the config values ¯\_(ツ)_/¯ +if (("$DRYRUN" == 1)); then + showConfValues + exit 0 +fi + +# run Main ┬┴┬┴┤(･_├┬┴┬┴ +main + +exit 0