diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
new file mode 100644
index 0000000..57264c0
--- /dev/null
+++ b/.github/CODEOWNERS
@@ -0,0 +1 @@
+* @FATMAP/sre
diff --git a/.github/workflows/lint.yaml b/.github/workflows/lint.yaml
new file mode 100644
index 0000000..672ddde
--- /dev/null
+++ b/.github/workflows/lint.yaml
@@ -0,0 +1,32 @@
+name: lint
+
+on:
+ push:
+ branches:
+ - '**'
+
+jobs:
+ make:
+ runs-on: ubuntu-latest
+
+ steps:
+ - name: Checkout Code
+ uses: actions/checkout@v2
+
+ - name: Install asdf
+ uses: asdf-vm/actions/setup@v1
+
+ - name: asdf cache
+ id: asdf-cache
+ uses: actions/cache@v2
+ with:
+ path: ~/.asdf/
+ key: ${{ runner.os }}-${{ hashFiles('**/.tool-versions') }}
+
+ - name: Install CD tools from .tool-versions
+ if: steps.asdf-cache.outputs.cache-hit != 'true'
+ uses: asdf-vm/actions/install@v1
+
+ - name: Run make lint
+ run: |
+ make lint
diff --git a/.gitignore b/.gitignore
index 66fd13c..2b031b4 100644
--- a/.gitignore
+++ b/.gitignore
@@ -4,6 +4,7 @@
*.dll
*.so
*.dylib
+github-file-sync
# Test binary, built with `go test -c`
*.test
@@ -13,3 +14,9 @@
# Dependency directories (remove the comment below to include it)
# vendor/
+
+# env files
+.env
+
+# testing file
+sync-testing/
diff --git a/.golangci.yml b/.golangci.yml
new file mode 100644
index 0000000..85a5507
--- /dev/null
+++ b/.golangci.yml
@@ -0,0 +1,82 @@
+linters-settings:
+ dupl:
+ threshold: 100
+ funlen:
+ lines: 100
+ statements: 50
+ gci:
+ local-prefixes: github.com/FATMAP/gha-file-sync
+ goconst:
+ min-len: 2
+ min-occurrences: 2
+ gocritic:
+ enabled-tags:
+ - diagnostic
+ - experimental
+ - opinionated
+ - performance
+ - style
+ disabled-checks:
+ - dupImport # https://github.com/go-critic/go-critic/issues/845
+ - ifElseChain
+ - octalLiteral
+ - whyNoLint
+ - wrapperFunc
+ gocyclo:
+ min-complexity: 15
+ goimports:
+ local-prefixes: github.com/FATMAP/avalanche
+ golint:
+ min-confidence: 0
+ gomnd:
+ settings:
+ mnd:
+ # don't include the "operation" and "assign"
+ checks: [argument,case,condition,return]
+ govet:
+ check-shadowing: true
+ lll:
+ line-length: 140
+ misspell:
+ locale: US
+ nolintlint:
+ allow-leading-space: true # don't require machine-readable nolint directives (i.e. with no leading space)
+ allow-unused: false # report any unused nolint directives
+ require-explanation: false # don't require an explanation for nolint directives
+ require-specific: false # don't require nolint directives to be specific about which linter is being skipped
+
+linters:
+ disable-all: true
+ enable:
+ - bodyclose
+ - depguard
+ - dogsled
+ - dupl
+ - errcheck
+ - exportloopref
+ - funlen
+ - gochecknoinits
+ - goconst
+ - gocyclo
+ - godot
+ - gofmt
+ - goimports
+ - goprintffuncname
+ - gosec
+ - gosimple
+ - govet
+ - ineffassign
+ - lll
+ - misspell
+ - nakedret
+ - noctx
+ - nolintlint
+ - prealloc
+ - staticcheck
+ - stylecheck
+ - testpackage
+ - typecheck
+ - unconvert
+ - unparam
+ - unused
+ - whitespace
diff --git a/.tool-versions b/.tool-versions
new file mode 100644
index 0000000..acdfa2a
--- /dev/null
+++ b/.tool-versions
@@ -0,0 +1,3 @@
+golang 1.20
+golangci-lint 1.52.2
+make 4.2.1
diff --git a/Dockerfile b/Dockerfile
new file mode 100644
index 0000000..c67a410
--- /dev/null
+++ b/Dockerfile
@@ -0,0 +1,31 @@
+#
+## build stage
+FROM golang:1.20 as builder
+
+LABEL maintainer="github.com/SlevinWasAlreadyTaken"
+
+WORKDIR /app
+
+# modules
+ARG CGO_ENABLED=0
+COPY go.mod ./
+COPY go.sum ./
+RUN go mod download
+
+# copy sources
+COPY . .
+
+# compile
+RUN go build -o /bin/github-file-sync
+
+#
+## run stage - minimalist final image
+FROM alpine:3.17
+
+# ensure glibc binaries is runnable by install glibc compatibility packages
+RUN apk add libc6-compat
+
+# get binary from build image
+COPY --from=builder /bin/github-file-sync /bin/github-file-sync
+
+ENTRYPOINT ["/bin/github-file-sync"]
diff --git a/LICENSE b/LICENSE
deleted file mode 100644
index f288702..0000000
--- a/LICENSE
+++ /dev/null
@@ -1,674 +0,0 @@
- GNU GENERAL PUBLIC LICENSE
- Version 3, 29 June 2007
-
- Copyright (C) 2007 Free Software Foundation, Inc.
- Everyone is permitted to copy and distribute verbatim copies
- of this license document, but changing it is not allowed.
-
- Preamble
-
- The GNU General Public License is a free, copyleft license for
-software and other kinds of works.
-
- The licenses for most software and other practical works are designed
-to take away your freedom to share and change the works. By contrast,
-the GNU General Public License is intended to guarantee your freedom to
-share and change all versions of a program--to make sure it remains free
-software for all its users. We, the Free Software Foundation, use the
-GNU General Public License for most of our software; it applies also to
-any other work released this way by its authors. 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
-them 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 prevent others from denying you
-these rights or asking you to surrender the rights. Therefore, you have
-certain responsibilities if you distribute copies of the software, or if
-you modify it: responsibilities to respect the freedom of others.
-
- For example, if you distribute copies of such a program, whether
-gratis or for a fee, you must pass on to the recipients the same
-freedoms that you received. 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.
-
- Developers that use the GNU GPL protect your rights with two steps:
-(1) assert copyright on the software, and (2) offer you this License
-giving you legal permission to copy, distribute and/or modify it.
-
- For the developers' and authors' protection, the GPL clearly explains
-that there is no warranty for this free software. For both users' and
-authors' sake, the GPL requires that modified versions be marked as
-changed, so that their problems will not be attributed erroneously to
-authors of previous versions.
-
- Some devices are designed to deny users access to install or run
-modified versions of the software inside them, although the manufacturer
-can do so. This is fundamentally incompatible with the aim of
-protecting users' freedom to change the software. The systematic
-pattern of such abuse occurs in the area of products for individuals to
-use, which is precisely where it is most unacceptable. Therefore, we
-have designed this version of the GPL to prohibit the practice for those
-products. If such problems arise substantially in other domains, we
-stand ready to extend this provision to those domains in future versions
-of the GPL, as needed to protect the freedom of users.
-
- Finally, every program is threatened constantly by software patents.
-States should not allow patents to restrict development and use of
-software on general-purpose computers, but in those that do, we wish to
-avoid the special danger that patents applied to a free program could
-make it effectively proprietary. To prevent this, the GPL assures that
-patents cannot be used to render the program non-free.
-
- The precise terms and conditions for copying, distribution and
-modification follow.
-
- TERMS AND CONDITIONS
-
- 0. Definitions.
-
- "This License" refers to version 3 of the GNU General Public License.
-
- "Copyright" also means copyright-like laws that apply to other kinds of
-works, such as semiconductor masks.
-
- "The Program" refers to any copyrightable work licensed under this
-License. Each licensee is addressed as "you". "Licensees" and
-"recipients" may be individuals or organizations.
-
- To "modify" a work means to copy from or adapt all or part of the work
-in a fashion requiring copyright permission, other than the making of an
-exact copy. The resulting work is called a "modified version" of the
-earlier work or a work "based on" the earlier work.
-
- A "covered work" means either the unmodified Program or a work based
-on the Program.
-
- To "propagate" a work means to do anything with it that, without
-permission, would make you directly or secondarily liable for
-infringement under applicable copyright law, except executing it on a
-computer or modifying a private copy. Propagation includes copying,
-distribution (with or without modification), making available to the
-public, and in some countries other activities as well.
-
- To "convey" a work means any kind of propagation that enables other
-parties to make or receive copies. Mere interaction with a user through
-a computer network, with no transfer of a copy, is not conveying.
-
- An interactive user interface displays "Appropriate Legal Notices"
-to the extent that it includes a convenient and prominently visible
-feature that (1) displays an appropriate copyright notice, and (2)
-tells the user that there is no warranty for the work (except to the
-extent that warranties are provided), that licensees may convey the
-work under this License, and how to view a copy of this License. If
-the interface presents a list of user commands or options, such as a
-menu, a prominent item in the list meets this criterion.
-
- 1. Source Code.
-
- The "source code" for a work means the preferred form of the work
-for making modifications to it. "Object code" means any non-source
-form of a work.
-
- A "Standard Interface" means an interface that either is an official
-standard defined by a recognized standards body, or, in the case of
-interfaces specified for a particular programming language, one that
-is widely used among developers working in that language.
-
- The "System Libraries" of an executable work include anything, other
-than the work as a whole, that (a) is included in the normal form of
-packaging a Major Component, but which is not part of that Major
-Component, and (b) serves only to enable use of the work with that
-Major Component, or to implement a Standard Interface for which an
-implementation is available to the public in source code form. A
-"Major Component", in this context, means a major essential component
-(kernel, window system, and so on) of the specific operating system
-(if any) on which the executable work runs, or a compiler used to
-produce the work, or an object code interpreter used to run it.
-
- The "Corresponding Source" for a work in object code form means all
-the source code needed to generate, install, and (for an executable
-work) run the object code and to modify the work, including scripts to
-control those activities. However, it does not include the work's
-System Libraries, or general-purpose tools or generally available free
-programs which are used unmodified in performing those activities but
-which are not part of the work. For example, Corresponding Source
-includes interface definition files associated with source files for
-the work, and the source code for shared libraries and dynamically
-linked subprograms that the work is specifically designed to require,
-such as by intimate data communication or control flow between those
-subprograms and other parts of the work.
-
- The Corresponding Source need not include anything that users
-can regenerate automatically from other parts of the Corresponding
-Source.
-
- The Corresponding Source for a work in source code form is that
-same work.
-
- 2. Basic Permissions.
-
- All rights granted under this License are granted for the term of
-copyright on the Program, and are irrevocable provided the stated
-conditions are met. This License explicitly affirms your unlimited
-permission to run the unmodified Program. The output from running a
-covered work is covered by this License only if the output, given its
-content, constitutes a covered work. This License acknowledges your
-rights of fair use or other equivalent, as provided by copyright law.
-
- You may make, run and propagate covered works that you do not
-convey, without conditions so long as your license otherwise remains
-in force. You may convey covered works to others for the sole purpose
-of having them make modifications exclusively for you, or provide you
-with facilities for running those works, provided that you comply with
-the terms of this License in conveying all material for which you do
-not control copyright. Those thus making or running the covered works
-for you must do so exclusively on your behalf, under your direction
-and control, on terms that prohibit them from making any copies of
-your copyrighted material outside their relationship with you.
-
- Conveying under any other circumstances is permitted solely under
-the conditions stated below. Sublicensing is not allowed; section 10
-makes it unnecessary.
-
- 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
-
- No covered work shall be deemed part of an effective technological
-measure under any applicable law fulfilling obligations under article
-11 of the WIPO copyright treaty adopted on 20 December 1996, or
-similar laws prohibiting or restricting circumvention of such
-measures.
-
- When you convey a covered work, you waive any legal power to forbid
-circumvention of technological measures to the extent such circumvention
-is effected by exercising rights under this License with respect to
-the covered work, and you disclaim any intention to limit operation or
-modification of the work as a means of enforcing, against the work's
-users, your or third parties' legal rights to forbid circumvention of
-technological measures.
-
- 4. Conveying Verbatim Copies.
-
- You may convey 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;
-keep intact all notices stating that this License and any
-non-permissive terms added in accord with section 7 apply to the code;
-keep intact all notices of the absence of any warranty; and give all
-recipients a copy of this License along with the Program.
-
- You may charge any price or no price for each copy that you convey,
-and you may offer support or warranty protection for a fee.
-
- 5. Conveying Modified Source Versions.
-
- You may convey a work based on the Program, or the modifications to
-produce it from the Program, in the form of source code under the
-terms of section 4, provided that you also meet all of these conditions:
-
- a) The work must carry prominent notices stating that you modified
- it, and giving a relevant date.
-
- b) The work must carry prominent notices stating that it is
- released under this License and any conditions added under section
- 7. This requirement modifies the requirement in section 4 to
- "keep intact all notices".
-
- c) You must license the entire work, as a whole, under this
- License to anyone who comes into possession of a copy. This
- License will therefore apply, along with any applicable section 7
- additional terms, to the whole of the work, and all its parts,
- regardless of how they are packaged. This License gives no
- permission to license the work in any other way, but it does not
- invalidate such permission if you have separately received it.
-
- d) If the work has interactive user interfaces, each must display
- Appropriate Legal Notices; however, if the Program has interactive
- interfaces that do not display Appropriate Legal Notices, your
- work need not make them do so.
-
- A compilation of a covered work with other separate and independent
-works, which are not by their nature extensions of the covered work,
-and which are not combined with it such as to form a larger program,
-in or on a volume of a storage or distribution medium, is called an
-"aggregate" if the compilation and its resulting copyright are not
-used to limit the access or legal rights of the compilation's users
-beyond what the individual works permit. Inclusion of a covered work
-in an aggregate does not cause this License to apply to the other
-parts of the aggregate.
-
- 6. Conveying Non-Source Forms.
-
- You may convey a covered work in object code form under the terms
-of sections 4 and 5, provided that you also convey the
-machine-readable Corresponding Source under the terms of this License,
-in one of these ways:
-
- a) Convey the object code in, or embodied in, a physical product
- (including a physical distribution medium), accompanied by the
- Corresponding Source fixed on a durable physical medium
- customarily used for software interchange.
-
- b) Convey the object code in, or embodied in, a physical product
- (including a physical distribution medium), accompanied by a
- written offer, valid for at least three years and valid for as
- long as you offer spare parts or customer support for that product
- model, to give anyone who possesses the object code either (1) a
- copy of the Corresponding Source for all the software in the
- product that is covered by this License, on a durable physical
- medium customarily used for software interchange, for a price no
- more than your reasonable cost of physically performing this
- conveying of source, or (2) access to copy the
- Corresponding Source from a network server at no charge.
-
- c) Convey individual copies of the object code with a copy of the
- written offer to provide the Corresponding Source. This
- alternative is allowed only occasionally and noncommercially, and
- only if you received the object code with such an offer, in accord
- with subsection 6b.
-
- d) Convey the object code by offering access from a designated
- place (gratis or for a charge), and offer equivalent access to the
- Corresponding Source in the same way through the same place at no
- further charge. You need not require recipients to copy the
- Corresponding Source along with the object code. If the place to
- copy the object code is a network server, the Corresponding Source
- may be on a different server (operated by you or a third party)
- that supports equivalent copying facilities, provided you maintain
- clear directions next to the object code saying where to find the
- Corresponding Source. Regardless of what server hosts the
- Corresponding Source, you remain obligated to ensure that it is
- available for as long as needed to satisfy these requirements.
-
- e) Convey the object code using peer-to-peer transmission, provided
- you inform other peers where the object code and Corresponding
- Source of the work are being offered to the general public at no
- charge under subsection 6d.
-
- A separable portion of the object code, whose source code is excluded
-from the Corresponding Source as a System Library, need not be
-included in conveying the object code work.
-
- A "User Product" is either (1) a "consumer product", which means any
-tangible personal property which is normally used for personal, family,
-or household purposes, or (2) anything designed or sold for incorporation
-into a dwelling. In determining whether a product is a consumer product,
-doubtful cases shall be resolved in favor of coverage. For a particular
-product received by a particular user, "normally used" refers to a
-typical or common use of that class of product, regardless of the status
-of the particular user or of the way in which the particular user
-actually uses, or expects or is expected to use, the product. A product
-is a consumer product regardless of whether the product has substantial
-commercial, industrial or non-consumer uses, unless such uses represent
-the only significant mode of use of the product.
-
- "Installation Information" for a User Product means any methods,
-procedures, authorization keys, or other information required to install
-and execute modified versions of a covered work in that User Product from
-a modified version of its Corresponding Source. The information must
-suffice to ensure that the continued functioning of the modified object
-code is in no case prevented or interfered with solely because
-modification has been made.
-
- If you convey an object code work under this section in, or with, or
-specifically for use in, a User Product, and the conveying occurs as
-part of a transaction in which the right of possession and use of the
-User Product is transferred to the recipient in perpetuity or for a
-fixed term (regardless of how the transaction is characterized), the
-Corresponding Source conveyed under this section must be accompanied
-by the Installation Information. But this requirement does not apply
-if neither you nor any third party retains the ability to install
-modified object code on the User Product (for example, the work has
-been installed in ROM).
-
- The requirement to provide Installation Information does not include a
-requirement to continue to provide support service, warranty, or updates
-for a work that has been modified or installed by the recipient, or for
-the User Product in which it has been modified or installed. Access to a
-network may be denied when the modification itself materially and
-adversely affects the operation of the network or violates the rules and
-protocols for communication across the network.
-
- Corresponding Source conveyed, and Installation Information provided,
-in accord with this section must be in a format that is publicly
-documented (and with an implementation available to the public in
-source code form), and must require no special password or key for
-unpacking, reading or copying.
-
- 7. Additional Terms.
-
- "Additional permissions" are terms that supplement the terms of this
-License by making exceptions from one or more of its conditions.
-Additional permissions that are applicable to the entire Program shall
-be treated as though they were included in this License, to the extent
-that they are valid under applicable law. If additional permissions
-apply only to part of the Program, that part may be used separately
-under those permissions, but the entire Program remains governed by
-this License without regard to the additional permissions.
-
- When you convey a copy of a covered work, you may at your option
-remove any additional permissions from that copy, or from any part of
-it. (Additional permissions may be written to require their own
-removal in certain cases when you modify the work.) You may place
-additional permissions on material, added by you to a covered work,
-for which you have or can give appropriate copyright permission.
-
- Notwithstanding any other provision of this License, for material you
-add to a covered work, you may (if authorized by the copyright holders of
-that material) supplement the terms of this License with terms:
-
- a) Disclaiming warranty or limiting liability differently from the
- terms of sections 15 and 16 of this License; or
-
- b) Requiring preservation of specified reasonable legal notices or
- author attributions in that material or in the Appropriate Legal
- Notices displayed by works containing it; or
-
- c) Prohibiting misrepresentation of the origin of that material, or
- requiring that modified versions of such material be marked in
- reasonable ways as different from the original version; or
-
- d) Limiting the use for publicity purposes of names of licensors or
- authors of the material; or
-
- e) Declining to grant rights under trademark law for use of some
- trade names, trademarks, or service marks; or
-
- f) Requiring indemnification of licensors and authors of that
- material by anyone who conveys the material (or modified versions of
- it) with contractual assumptions of liability to the recipient, for
- any liability that these contractual assumptions directly impose on
- those licensors and authors.
-
- All other non-permissive additional terms are considered "further
-restrictions" within the meaning of section 10. If the Program as you
-received it, or any part of it, contains a notice stating that it is
-governed by this License along with a term that is a further
-restriction, you may remove that term. If a license document contains
-a further restriction but permits relicensing or conveying under this
-License, you may add to a covered work material governed by the terms
-of that license document, provided that the further restriction does
-not survive such relicensing or conveying.
-
- If you add terms to a covered work in accord with this section, you
-must place, in the relevant source files, a statement of the
-additional terms that apply to those files, or a notice indicating
-where to find the applicable terms.
-
- Additional terms, permissive or non-permissive, may be stated in the
-form of a separately written license, or stated as exceptions;
-the above requirements apply either way.
-
- 8. Termination.
-
- You may not propagate or modify a covered work except as expressly
-provided under this License. Any attempt otherwise to propagate or
-modify it is void, and will automatically terminate your rights under
-this License (including any patent licenses granted under the third
-paragraph of section 11).
-
- However, if you cease all violation of this License, then your
-license from a particular copyright holder is reinstated (a)
-provisionally, unless and until the copyright holder explicitly and
-finally terminates your license, and (b) permanently, if the copyright
-holder fails to notify you of the violation by some reasonable means
-prior to 60 days after the cessation.
-
- Moreover, your license from a particular copyright holder is
-reinstated permanently if the copyright holder notifies you of the
-violation by some reasonable means, this is the first time you have
-received notice of violation of this License (for any work) from that
-copyright holder, and you cure the violation prior to 30 days after
-your receipt of the notice.
-
- Termination of your rights under this section does not terminate the
-licenses of parties who have received copies or rights from you under
-this License. If your rights have been terminated and not permanently
-reinstated, you do not qualify to receive new licenses for the same
-material under section 10.
-
- 9. Acceptance Not Required for Having Copies.
-
- You are not required to accept this License in order to receive or
-run a copy of the Program. Ancillary propagation of a covered work
-occurring solely as a consequence of using peer-to-peer transmission
-to receive a copy likewise does not require acceptance. However,
-nothing other than this License grants you permission to propagate or
-modify any covered work. These actions infringe copyright if you do
-not accept this License. Therefore, by modifying or propagating a
-covered work, you indicate your acceptance of this License to do so.
-
- 10. Automatic Licensing of Downstream Recipients.
-
- Each time you convey a covered work, the recipient automatically
-receives a license from the original licensors, to run, modify and
-propagate that work, subject to this License. You are not responsible
-for enforcing compliance by third parties with this License.
-
- An "entity transaction" is a transaction transferring control of an
-organization, or substantially all assets of one, or subdividing an
-organization, or merging organizations. If propagation of a covered
-work results from an entity transaction, each party to that
-transaction who receives a copy of the work also receives whatever
-licenses to the work the party's predecessor in interest had or could
-give under the previous paragraph, plus a right to possession of the
-Corresponding Source of the work from the predecessor in interest, if
-the predecessor has it or can get it with reasonable efforts.
-
- You may not impose any further restrictions on the exercise of the
-rights granted or affirmed under this License. For example, you may
-not impose a license fee, royalty, or other charge for exercise of
-rights granted under this License, and you may not initiate litigation
-(including a cross-claim or counterclaim in a lawsuit) alleging that
-any patent claim is infringed by making, using, selling, offering for
-sale, or importing the Program or any portion of it.
-
- 11. Patents.
-
- A "contributor" is a copyright holder who authorizes use under this
-License of the Program or a work on which the Program is based. The
-work thus licensed is called the contributor's "contributor version".
-
- A contributor's "essential patent claims" are all patent claims
-owned or controlled by the contributor, whether already acquired or
-hereafter acquired, that would be infringed by some manner, permitted
-by this License, of making, using, or selling its contributor version,
-but do not include claims that would be infringed only as a
-consequence of further modification of the contributor version. For
-purposes of this definition, "control" includes the right to grant
-patent sublicenses in a manner consistent with the requirements of
-this License.
-
- Each contributor grants you a non-exclusive, worldwide, royalty-free
-patent license under the contributor's essential patent claims, to
-make, use, sell, offer for sale, import and otherwise run, modify and
-propagate the contents of its contributor version.
-
- In the following three paragraphs, a "patent license" is any express
-agreement or commitment, however denominated, not to enforce a patent
-(such as an express permission to practice a patent or covenant not to
-sue for patent infringement). To "grant" such a patent license to a
-party means to make such an agreement or commitment not to enforce a
-patent against the party.
-
- If you convey a covered work, knowingly relying on a patent license,
-and the Corresponding Source of the work is not available for anyone
-to copy, free of charge and under the terms of this License, through a
-publicly available network server or other readily accessible means,
-then you must either (1) cause the Corresponding Source to be so
-available, or (2) arrange to deprive yourself of the benefit of the
-patent license for this particular work, or (3) arrange, in a manner
-consistent with the requirements of this License, to extend the patent
-license to downstream recipients. "Knowingly relying" means you have
-actual knowledge that, but for the patent license, your conveying the
-covered work in a country, or your recipient's use of the covered work
-in a country, would infringe one or more identifiable patents in that
-country that you have reason to believe are valid.
-
- If, pursuant to or in connection with a single transaction or
-arrangement, you convey, or propagate by procuring conveyance of, a
-covered work, and grant a patent license to some of the parties
-receiving the covered work authorizing them to use, propagate, modify
-or convey a specific copy of the covered work, then the patent license
-you grant is automatically extended to all recipients of the covered
-work and works based on it.
-
- A patent license is "discriminatory" if it does not include within
-the scope of its coverage, prohibits the exercise of, or is
-conditioned on the non-exercise of one or more of the rights that are
-specifically granted under this License. You may not convey a covered
-work if you are a party to an arrangement with a third party that is
-in the business of distributing software, under which you make payment
-to the third party based on the extent of your activity of conveying
-the work, and under which the third party grants, to any of the
-parties who would receive the covered work from you, a discriminatory
-patent license (a) in connection with copies of the covered work
-conveyed by you (or copies made from those copies), or (b) primarily
-for and in connection with specific products or compilations that
-contain the covered work, unless you entered into that arrangement,
-or that patent license was granted, prior to 28 March 2007.
-
- Nothing in this License shall be construed as excluding or limiting
-any implied license or other defenses to infringement that may
-otherwise be available to you under applicable patent law.
-
- 12. No Surrender of Others' Freedom.
-
- If 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 convey a
-covered work so as to satisfy simultaneously your obligations under this
-License and any other pertinent obligations, then as a consequence you may
-not convey it at all. For example, if you agree to terms that obligate you
-to collect a royalty for further conveying from those to whom you convey
-the Program, the only way you could satisfy both those terms and this
-License would be to refrain entirely from conveying the Program.
-
- 13. Use with the GNU Affero General Public License.
-
- Notwithstanding any other provision of this License, you have
-permission to link or combine any covered work with a work licensed
-under version 3 of the GNU Affero General Public License into a single
-combined work, and to convey the resulting work. The terms of this
-License will continue to apply to the part which is the covered work,
-but the special requirements of the GNU Affero General Public License,
-section 13, concerning interaction through a network will apply to the
-combination as such.
-
- 14. Revised Versions of this License.
-
- The Free Software Foundation may publish revised and/or new versions of
-the GNU 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 that a certain numbered version of the GNU General
-Public License "or any later version" applies to it, you have the
-option of following the terms and conditions either of that numbered
-version or of any later version published by the Free Software
-Foundation. If the Program does not specify a version number of the
-GNU General Public License, you may choose any version ever published
-by the Free Software Foundation.
-
- If the Program specifies that a proxy can decide which future
-versions of the GNU General Public License can be used, that proxy's
-public statement of acceptance of a version permanently authorizes you
-to choose that version for the Program.
-
- Later license versions may give you additional or different
-permissions. However, no additional obligations are imposed on any
-author or copyright holder as a result of your choosing to follow a
-later version.
-
- 15. Disclaimer of Warranty.
-
- 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.
-
- 16. Limitation of Liability.
-
- IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
-WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
-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.
-
- 17. Interpretation of Sections 15 and 16.
-
- If the disclaimer of warranty and limitation of liability provided
-above cannot be given local legal effect according to their terms,
-reviewing courts shall apply local law that most closely approximates
-an absolute waiver of all civil liability in connection with the
-Program, unless a warranty or assumption of liability accompanies a
-copy of the Program in return for a fee.
-
- 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
-state 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 3 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, see .
-
-Also add information on how to contact you by electronic and paper mail.
-
- If the program does terminal interaction, make it output a short
-notice like this when it starts in an interactive mode:
-
- Copyright (C)
- This program 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, your program's commands
-might be different; for a GUI interface, you would use an "about box".
-
- You should also get your employer (if you work as a programmer) or school,
-if any, to sign a "copyright disclaimer" for the program, if necessary.
-For more information on this, and how to apply and follow the GNU GPL, see
-.
-
- The GNU 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. But first, please read
-.
diff --git a/Makefile b/Makefile
new file mode 100644
index 0000000..473078b
--- /dev/null
+++ b/Makefile
@@ -0,0 +1,10 @@
+#!make
+
+MAKEFLAGS += \
+--warn-undefined-variables
+SHELL = /usr/bin/env bash
+.SHELLFLAGS := -O globstar -O extglob -eu -o pipefail -c
+
+.PHONY: lint
+lint:
+ golangci-lint run --config .golangci.yml --timeout 3m
diff --git a/README.md b/README.md
index c48ad1f..9c39a04 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,49 @@
# gha-file-sync
-Github Action for Cross-Repos File Synchronisation using Pull Requests
+
+Github Action for Cross-Repo Files Synchronization using automatic Pull Requests.
+## What
+
+For a list of given repositories and file bindings, this action will open/update pull requests to synchronize the files that have changed.
+The source of files is the repository where the action runs.
+
+For each targeted repository:
+ 1. Clone the repository.
+ 2. Compute the final branch name and PR according to existing opened PRs.
+ 3. Check if changes have been made following files bindings configuration.
+ 4. Create or update a pull request if changes have been detected.
+ 5. Clean all created files locally.
+
+## Configuration
+
+See `action.yml` for more information.
+## Missing
+
+This action only manages to synchronize new files and updated files.
+Removals or renames are not handled yet.
+
+## Features to add
+
+#### Handling of removed/renamed files
+
+Today, because only a raw copy of the source files is used, the removals and renames of files are not handled yet.
+It is currently advised to blank a file that you want to remove to make it ineffective without having to remove it manually from all repositories.
+#### Commits messages as PR desc
+
+Today, the PR description and comments are pointing by default to the release which triggered the synchronization.
+It would be better to provide more information about the release, for example:
+- the release description.
+- the list of added commits.
+- the original PR description.
+#### 'Customs' Detection
+
+Sometimes the synchronized files are customized locally for some reasons, it is hard to know about it when tens of repositories are involved.
+The action should raise a warning somewhere if it detects a customization. Some rules as examples:
+
+In order to find customization, it should compare the target files with the version `n - 1` of the source files to see if it was already differing.
+
+- if it is a PR creation:
+ - WARN in the PR desc
+- if it is a PR update and the title does not contain `CUSTOM_DETECTED`:
+ - WARN in a comment + update the title with sync `CUSTOM_DETECTED`
+- if it is a PR update and the title contains `CUSTOM_DETECTED`:
+ - WARN in a comment
diff --git a/action.yml b/action.yml
new file mode 100644
index 0000000..1bb4f39
--- /dev/null
+++ b/action.yml
@@ -0,0 +1,44 @@
+name: github-file-sync
+author: "SlevinWasAlreadyTaken"
+description: "Help to synchronize files between repositories by opening pull requests."
+inputs:
+ REPOSITORIES:
+ description: "Line-separated list of repositories that should receive files updates through automatic pull requests."
+ required: true
+ FILES_BINDINGS:
+ description: "Line-separated list of files bindings that should be trigger updates"
+ required: true
+ DRY_RUN:
+ description: "Dry run switch: set to false to create for real pull requests"
+ default: 'true'
+ GITHUB_TOKEN:
+ description: "Line-separated list of files bindings that should be trigger updates"
+ required: true
+ GITHUB_URL:
+ description: "The domain of the Github instance hosting your repository"
+ default: "github.com"
+ COMMIT_MESSAGE:
+ description: "Commit message"
+ default: "minor CHORE file synchronization from a gha-file-sync action"
+ PR_TITLE:
+ description: "The title of the sync PR"
+ default: "minor CHORE file synchronization from a gha-file-sync action"
+ FILE_SYNC_BRANCH_REGEXP:
+ description: "Regexp string used to determine if an existing file sync pull request already exists. Update it if found instead of creating a new one."
+ default: "[0-9]{4}-[0-9]{2}-[0-9]{2}-sync-file-pr.*"
+ WORKSPACE:
+ description: "folder for the runner to store temporary files"
+ default: "/tmp"
+runs:
+ using: docker
+ image: Dockerfile
+ env:
+ REPOSITORIES: ${{ inputs.REPOSITORIES }}
+ FILES_BINDINGS: ${{ inputs.FILES_BINDINGS }}
+ DRY_RUN: ${{ inputs.DRY_RUN }}
+ GITHUB_TOKEN: ${{ inputs.GITHUB_TOKEN }}
+ GITHUB_URL: ${{ inputs.GITHUB_URL }}
+ COMMIT_MESSAGE: ${{ inputs.COMMIT_MESSAGE }}
+ PR_TITLE: ${{ inputs.PR_TITLE }}
+ FILE_SYNC_BRANCH_REGEXP: ${{ inputs.FILE_SYNC_BRANCH_REGEXP }}
+ WORKSPACE: ${{ inputs.WORKSPACE }}
diff --git a/go.mod b/go.mod
new file mode 100644
index 0000000..657ae46
--- /dev/null
+++ b/go.mod
@@ -0,0 +1,35 @@
+module github-file-sync
+
+go 1.20
+
+require (
+ github.com/go-git/go-git/v5 v5.6.1
+ github.com/google/go-github v17.0.0+incompatible
+ github.com/otiai10/copy v1.9.0
+ golang.org/x/exp v0.0.0-20230321023759-10a507213a29
+ golang.org/x/oauth2 v0.0.0-20180821212333-d2e6202438be
+)
+
+require (
+ github.com/Microsoft/go-winio v0.5.2 // indirect
+ github.com/ProtonMail/go-crypto v0.0.0-20230217124315-7d5c6f04bbb8 // indirect
+ github.com/acomagu/bufpipe v1.0.4 // indirect
+ github.com/cloudflare/circl v1.1.0 // indirect
+ github.com/emirpasic/gods v1.18.1 // indirect
+ github.com/go-git/gcfg v1.5.0 // indirect
+ github.com/go-git/go-billy/v5 v5.4.1 // indirect
+ github.com/golang/protobuf v1.3.2 // indirect
+ github.com/google/go-querystring v1.1.0 // indirect
+ github.com/imdario/mergo v0.3.13 // indirect
+ github.com/jbenet/go-context v0.0.0-20150711004518-d14ea06fba99 // indirect
+ github.com/kevinburke/ssh_config v1.2.0 // indirect
+ github.com/pjbgf/sha1cd v0.3.0 // indirect
+ github.com/sergi/go-diff v1.1.0 // indirect
+ github.com/skeema/knownhosts v1.1.0 // indirect
+ github.com/xanzy/ssh-agent v0.3.3 // indirect
+ golang.org/x/crypto v0.6.0 // indirect
+ golang.org/x/net v0.7.0 // indirect
+ golang.org/x/sys v0.5.0 // indirect
+ google.golang.org/appengine v1.6.7 // indirect
+ gopkg.in/warnings.v0 v0.1.2 // indirect
+)
diff --git a/go.sum b/go.sum
new file mode 100644
index 0000000..0ae6e30
--- /dev/null
+++ b/go.sum
@@ -0,0 +1,164 @@
+github.com/Microsoft/go-winio v0.5.2 h1:a9IhgEQBCUEk6QCdml9CiJGhAws+YwffDHEMp1VMrpA=
+github.com/Microsoft/go-winio v0.5.2/go.mod h1:WpS1mjBmmwHBEWmogvA2mj8546UReBk4v8QkMxJ6pZY=
+github.com/ProtonMail/go-crypto v0.0.0-20230217124315-7d5c6f04bbb8 h1:wPbRQzjjwFc0ih8puEVAOFGELsn1zoIIYdxvML7mDxA=
+github.com/ProtonMail/go-crypto v0.0.0-20230217124315-7d5c6f04bbb8/go.mod h1:I0gYDMZ6Z5GRU7l58bNFSkPTFN6Yl12dsUlAZ8xy98g=
+github.com/acomagu/bufpipe v1.0.4 h1:e3H4WUzM3npvo5uv95QuJM3cQspFNtFBzvJ2oNjKIDQ=
+github.com/acomagu/bufpipe v1.0.4/go.mod h1:mxdxdup/WdsKVreO5GpW4+M/1CE2sMG4jeGJ2sYmHc4=
+github.com/anmitsu/go-shlex v0.0.0-20200514113438-38f4b401e2be h1:9AeTilPcZAjCFIImctFaOjnTIavg87rW78vTPkQqLI8=
+github.com/anmitsu/go-shlex v0.0.0-20200514113438-38f4b401e2be/go.mod h1:ySMOLuWl6zY27l47sB3qLNK6tF2fkHG55UZxx8oIVo4=
+github.com/armon/go-socks5 v0.0.0-20160902184237-e75332964ef5 h1:0CwZNZbxp69SHPdPJAN/hZIm0C4OItdklCFmMRWYpio=
+github.com/armon/go-socks5 v0.0.0-20160902184237-e75332964ef5/go.mod h1:wHh0iHkYZB8zMSxRWpUBQtwG5a7fFgvEO+odwuTv2gs=
+github.com/bwesterb/go-ristretto v1.2.0/go.mod h1:fUIoIZaG73pV5biE2Blr2xEzDoMj7NFEuV9ekS419A0=
+github.com/cloudflare/circl v1.1.0 h1:bZgT/A+cikZnKIwn7xL2OBj012Bmvho/o6RpRvv3GKY=
+github.com/cloudflare/circl v1.1.0/go.mod h1:prBCrKB9DV4poKZY1l9zBXg2QJY7mvgRvtMxxK7fi4I=
+github.com/creack/pty v1.1.9/go.mod h1:oKZEueFk5CKHvIhNR5MUki03XCEU+Q6VDXinZuGJ33E=
+github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
+github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/emirpasic/gods v1.18.1 h1:FXtiHYKDGKCW2KzwZKx0iC0PQmdlorYgdFG9jPXJ1Bc=
+github.com/emirpasic/gods v1.18.1/go.mod h1:8tpGGwCnJ5H4r6BWwaV6OrWmMoPhUl5jm/FMNAnJvWQ=
+github.com/gliderlabs/ssh v0.3.5 h1:OcaySEmAQJgyYcArR+gGGTHCyE7nvhEMTlYY+Dp8CpY=
+github.com/gliderlabs/ssh v0.3.5/go.mod h1:8XB4KraRrX39qHhT6yxPsHedjA08I/uBVwj4xC+/+z4=
+github.com/go-git/gcfg v1.5.0 h1:Q5ViNfGF8zFgyJWPqYwA7qGFoMTEiBmdlkcfRmpIMa4=
+github.com/go-git/gcfg v1.5.0/go.mod h1:5m20vg6GwYabIxaOonVkTdrILxQMpEShl1xiMF4ua+E=
+github.com/go-git/go-billy/v5 v5.3.1/go.mod h1:pmpqyWchKfYfrkb/UVH4otLvyi/5gJlGI4Hb3ZqZ3W0=
+github.com/go-git/go-billy/v5 v5.4.1 h1:Uwp5tDRkPr+l/TnbHOQzp+tmJfLceOlbVucgpTz8ix4=
+github.com/go-git/go-billy/v5 v5.4.1/go.mod h1:vjbugF6Fz7JIflbVpl1hJsGjSHNltrSw45YK/ukIvQg=
+github.com/go-git/go-git-fixtures/v4 v4.3.1 h1:y5z6dd3qi8Hl+stezc8p3JxDkoTRqMAlKnXHuzrfjTQ=
+github.com/go-git/go-git-fixtures/v4 v4.3.1/go.mod h1:8LHG1a3SRW71ettAD/jW13h8c6AqjVSeL11RAdgaqpo=
+github.com/go-git/go-git/v5 v5.6.1 h1:q4ZRqQl4pR/ZJHc1L5CFjGA1a10u76aV1iC+nh+bHsk=
+github.com/go-git/go-git/v5 v5.6.1/go.mod h1:mvyoL6Unz0PiTQrGQfSfiLFhBH1c1e84ylC2MDs4ee8=
+github.com/golang/protobuf v1.3.1/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5yJMmIC1U=
+github.com/golang/protobuf v1.3.2 h1:6nsPYzhq5kReh6QImI3k5qWzO4PEbvbIW2cwSfR/6xs=
+github.com/golang/protobuf v1.3.2/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5yJMmIC1U=
+github.com/google/go-cmp v0.5.2/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
+github.com/google/go-cmp v0.5.9 h1:O2Tfq5qg4qc4AmwVlvv0oLiVAGB7enBSJ2x2DqQFi38=
+github.com/google/go-cmp v0.5.9/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY=
+github.com/google/go-github v17.0.0+incompatible h1:N0LgJ1j65A7kfXrZnUDaYCs/Sf4rEjNlfyDHW9dolSY=
+github.com/google/go-github v17.0.0+incompatible/go.mod h1:zLgOLi98H3fifZn+44m+umXrS52loVEgC2AApnigrVQ=
+github.com/google/go-querystring v1.1.0 h1:AnCroh3fv4ZBgVIf1Iwtovgjaw/GiKJo8M8yD/fhyJ8=
+github.com/google/go-querystring v1.1.0/go.mod h1:Kcdr2DB4koayq7X8pmAG4sNG59So17icRSOU623lUBU=
+github.com/imdario/mergo v0.3.13 h1:lFzP57bqS/wsqKssCGmtLAb8A0wKjLGrve2q3PPVcBk=
+github.com/imdario/mergo v0.3.13/go.mod h1:4lJ1jqUDcsbIECGy0RUJAXNIhg+6ocWgb1ALK2O4oXg=
+github.com/jbenet/go-context v0.0.0-20150711004518-d14ea06fba99 h1:BQSFePA1RWJOlocH6Fxy8MmwDt+yVQYULKfN0RoTN8A=
+github.com/jbenet/go-context v0.0.0-20150711004518-d14ea06fba99/go.mod h1:1lJo3i6rXxKeerYnT8Nvf0QmHCRC1n8sfWVwXF2Frvo=
+github.com/jessevdk/go-flags v1.5.0/go.mod h1:Fw0T6WPc1dYxT4mKEZRfG5kJhaTDP9pj1c2EWnYs/m4=
+github.com/kevinburke/ssh_config v1.2.0 h1:x584FjTGwHzMwvHx18PXxbBVzfnxogHaAReU4gf13a4=
+github.com/kevinburke/ssh_config v1.2.0/go.mod h1:CT57kijsi8u/K/BOFA39wgDQJ9CxiF4nAY/ojJ6r6mM=
+github.com/kr/pretty v0.1.0/go.mod h1:dAy3ld7l9f0ibDNOQOHHMYYIIbhfbHSm3C4ZsoJORNo=
+github.com/kr/pretty v0.2.1 h1:Fmg33tUaq4/8ym9TJN1x7sLJnHVwhP33CNkpYV/7rwI=
+github.com/kr/pretty v0.2.1/go.mod h1:ipq/a2n7PKx3OHsz4KJII5eveXtPO4qwEXGdVfWzfnI=
+github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ=
+github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI=
+github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY=
+github.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE=
+github.com/matryer/is v1.2.0 h1:92UTHpy8CDwaJ08GqLDzhhuixiBUUD1p3AU6PHddz4A=
+github.com/matryer/is v1.2.0/go.mod h1:2fLPjFQM9rhQ15aVEtbuwhJinnOqrmgXPNdZsdwlWXA=
+github.com/mmcloughlin/avo v0.5.0/go.mod h1:ChHFdoV7ql95Wi7vuq2YT1bwCJqiWdZrQ1im3VujLYM=
+github.com/niemeyer/pretty v0.0.0-20200227124842-a10e7caefd8e/go.mod h1:zD1mROLANZcx1PVRCS0qkT7pwLkGfwJo4zjcN/Tysno=
+github.com/otiai10/copy v1.9.0 h1:7KFNiCgZ91Ru4qW4CWPf/7jqtxLagGRmIxWldPP9VY4=
+github.com/otiai10/copy v1.9.0/go.mod h1:hsfX19wcn0UWIHUQ3/4fHuehhk2UyArQ9dVFAn3FczI=
+github.com/otiai10/curr v0.0.0-20150429015615-9b4961190c95/go.mod h1:9qAhocn7zKJG+0mI8eUu6xqkFDYS2kb2saOteoSB3cE=
+github.com/otiai10/curr v1.0.0/go.mod h1:LskTG5wDwr8Rs+nNQ+1LlxRjAtTZZjtJW4rMXl6j4vs=
+github.com/otiai10/mint v1.3.0/go.mod h1:F5AjcsTsWUqX+Na9fpHb52P8pcRX2CI6A3ctIT91xUo=
+github.com/otiai10/mint v1.4.0 h1:umwcf7gbpEwf7WFzqmWwSv0CzbeMsae2u9ZvpP8j2q4=
+github.com/otiai10/mint v1.4.0/go.mod h1:gifjb2MYOoULtKLqUAEILUG/9KONW6f7YsJ6vQLTlFI=
+github.com/pjbgf/sha1cd v0.3.0 h1:4D5XXmUUBUl/xQ6IjCkEAbqXskkq/4O7LmGn0AqMDs4=
+github.com/pjbgf/sha1cd v0.3.0/go.mod h1:nZ1rrWOcGJ5uZgEEVL1VUM9iRQiZvWdbZjkKyFzPPsI=
+github.com/pkg/errors v0.9.1 h1:FEBLx1zS214owpjy7qsBeixbURkuhQAwrK5UwLGTwt4=
+github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=
+github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
+github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
+github.com/sergi/go-diff v1.1.0 h1:we8PVUC3FE2uYfodKH/nBHMSetSfHDR6scGdBi+erh0=
+github.com/sergi/go-diff v1.1.0/go.mod h1:STckp+ISIX8hZLjrqAeVduY0gWCT9IjLuqbuNXdaHfM=
+github.com/sirupsen/logrus v1.7.0/go.mod h1:yWOB1SBYBC5VeMP7gHvWumXLIWorT60ONWic61uBYv0=
+github.com/skeema/knownhosts v1.1.0 h1:Wvr9V0MxhjRbl3f9nMnKnFfiWTJmtECJ9Njkea3ysW0=
+github.com/skeema/knownhosts v1.1.0/go.mod h1:sKFq3RD6/TKZkSWn8boUbDC7Qkgcv+8XXijpFO6roag=
+github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
+github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs=
+github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81PSLYec5m4=
+github.com/stretchr/testify v1.7.0 h1:nwc3DEeHmmLAfoZucVR881uASk0Mfjw8xYJ99tb5CcY=
+github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
+github.com/xanzy/ssh-agent v0.3.3 h1:+/15pJfg/RsTxqYcX6fHqOXZwwMP+2VyYWJeWM2qQFM=
+github.com/xanzy/ssh-agent v0.3.3/go.mod h1:6dzNDKs0J9rVPHPhaGCukekBHKqfl+L3KghI1Bc68Uw=
+github.com/yuin/goldmark v1.4.13/go.mod h1:6yULJ656Px+3vBD8DxQVa3kxgyrAnzto9xy5taEt/CY=
+golang.org/x/arch v0.1.0/go.mod h1:5om86z9Hs0C8fWVUuoMHwpExlXzs5Tkyp9hOrfG7pp8=
+golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
+golang.org/x/crypto v0.0.0-20210921155107-089bfa567519/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc=
+golang.org/x/crypto v0.0.0-20220525230936-793ad666bf5e/go.mod h1:IxCIyHEi3zRg3s0A5j5BB6A9Jmi73HwBIUl50j+osU4=
+golang.org/x/crypto v0.0.0-20220622213112-05595931fe9d/go.mod h1:IxCIyHEi3zRg3s0A5j5BB6A9Jmi73HwBIUl50j+osU4=
+golang.org/x/crypto v0.0.0-20220826181053-bd7e27e6170d/go.mod h1:IxCIyHEi3zRg3s0A5j5BB6A9Jmi73HwBIUl50j+osU4=
+golang.org/x/crypto v0.1.0/go.mod h1:RecgLatLF4+eUMCP1PoPZQb+cVrJcOPbHkTkbkB9sbw=
+golang.org/x/crypto v0.6.0 h1:qfktjS5LUO+fFKeJXZ+ikTRijMmljikvG68fpMMruSc=
+golang.org/x/crypto v0.6.0/go.mod h1:OFC/31mSvZgRz0V1QTNCzfAI1aIRzbiufJtkMIlEp58=
+golang.org/x/exp v0.0.0-20230321023759-10a507213a29 h1:ooxPy7fPvB4kwsA2h+iBNHkAbp/4JxTSwCmvdjEYmug=
+golang.org/x/exp v0.0.0-20230321023759-10a507213a29/go.mod h1:CxIveKay+FTh1D0yPZemJVgC/95VzuuOLq5Qi4xnoYc=
+golang.org/x/mod v0.6.0-dev.0.20220419223038-86c51ed26bb4/go.mod h1:jJ57K6gSWd91VN4djpZkiMVwK6gcyfeH4XE8wZrZaV4=
+golang.org/x/mod v0.6.0/go.mod h1:4mET923SAdbXp2ki8ey+zGs1SLqsuM2Y0uvdZR/fUNI=
+golang.org/x/net v0.0.0-20190603091049-60506f45cf65/go.mod h1:HSz+uSET+XFnRR8LxR5pz3Of3rY3CfYBVs4xY44aLks=
+golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
+golang.org/x/net v0.0.0-20210226172049-e18ecbb05110/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg=
+golang.org/x/net v0.0.0-20211112202133-69e39bad7dc2/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y=
+golang.org/x/net v0.0.0-20220722155237-a158d28d115b/go.mod h1:XRhObCWvk6IyKnWLug+ECip1KBveYUHfp+8e9klMJ9c=
+golang.org/x/net v0.0.0-20220826154423-83b083e8dc8b/go.mod h1:YDH+HFinaLZZlnHAfSS6ZXJJ9M9t4Dl22yv3iI2vPwk=
+golang.org/x/net v0.1.0/go.mod h1:Cx3nUiGt4eDBEyega/BKRp+/AlGL8hYe7U9odMt2Cco=
+golang.org/x/net v0.6.0/go.mod h1:2Tu9+aMcznHK/AK1HMvgo6xiTLG5rD5rZLDS+rp2Bjs=
+golang.org/x/net v0.7.0 h1:rJrUqqhjsgNp7KqAIc25s9pZnjU7TUcSY7HcVZjdn1g=
+golang.org/x/net v0.7.0/go.mod h1:2Tu9+aMcznHK/AK1HMvgo6xiTLG5rD5rZLDS+rp2Bjs=
+golang.org/x/oauth2 v0.0.0-20180821212333-d2e6202438be h1:vEDujvNQGv4jgYKudGeI/+DAX4Jffq6hpD55MmoEvKs=
+golang.org/x/oauth2 v0.0.0-20180821212333-d2e6202438be/go.mod h1:N/0e6XlmueqKjAGxoOufVs8QHGRruUQn6yWY3a++T0U=
+golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
+golang.org/x/sync v0.0.0-20220722155255-886fb9371eb4/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
+golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
+golang.org/x/sys v0.0.0-20191026070338-33540a1f6037/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
+golang.org/x/sys v0.0.0-20200302150141-5c8b2ff67527/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
+golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
+golang.org/x/sys v0.0.0-20210124154548-22da62e12c0c/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
+golang.org/x/sys v0.0.0-20210320140829-1e4c9ba3b0c4/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
+golang.org/x/sys v0.0.0-20210423082822-04245dca01da/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
+golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/sys v0.0.0-20211007075335-d3039528d8ac/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/sys v0.0.0-20220520151302-bc2c85ada10a/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/sys v0.0.0-20220722155257-8c9f86f7a55f/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/sys v0.0.0-20220728004956-3c1f35247d10/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/sys v0.0.0-20220825204002-c680a09ffe64/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/sys v0.1.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/sys v0.3.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/sys v0.5.0 h1:MUK/U/4lj1t1oPg0HfuXDN/Z1wv31ZJ/YcPiGccS4DU=
+golang.org/x/sys v0.5.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo=
+golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8=
+golang.org/x/term v0.0.0-20220722155259-a9ba230a4035/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8=
+golang.org/x/term v0.1.0/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8=
+golang.org/x/term v0.5.0 h1:n2a8QNdAb0sZNpU9R1ALUXBbY+w51fCQDN+7EdxNBsY=
+golang.org/x/term v0.5.0/go.mod h1:jMB1sMXY+tzblOD4FWmEbocvup2/aLOaQEp7JmGp78k=
+golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
+golang.org/x/text v0.3.2/go.mod h1:bEr9sfX3Q8Zfm5fL9x+3itogRgK3+ptLWKqgva+5dAk=
+golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
+golang.org/x/text v0.3.6/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
+golang.org/x/text v0.3.7/go.mod h1:u+2+/6zg+i71rQMx5EYifcz6MCKuco9NR6JIITiCfzQ=
+golang.org/x/text v0.4.0/go.mod h1:mrYo+phRRbMaCq/xk9113O4dZlRixOauAjOtrjsXDZ8=
+golang.org/x/text v0.7.0 h1:4BRB4x83lYWy72KwLD/qYDuTu7q9PjSagHvijDw7cLo=
+golang.org/x/text v0.7.0/go.mod h1:mrYo+phRRbMaCq/xk9113O4dZlRixOauAjOtrjsXDZ8=
+golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
+golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo=
+golang.org/x/tools v0.1.12/go.mod h1:hNGJHUnrk76NpqgfD5Aqm5Crs+Hm0VOH/i9J2+nxYbc=
+golang.org/x/tools v0.2.0/go.mod h1:y4OqIKeOV/fWJetJ8bXPU1sEVniLMIyDAZWeHdV+NTA=
+golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
+golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
+google.golang.org/appengine v1.6.7 h1:FZR1q0exgwxzPzp/aF+VccGrSfxfPpkBqjIIEq3ru6c=
+google.golang.org/appengine v1.6.7/go.mod h1:8WjMMxjGQR8xUklV/ARdw2HLXBOI7O7uCIDZVag1xfc=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/check.v1 v1.0.0-20200227125254-8fa46927fb4f/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c h1:Hei/4ADfdWqJk1ZMxUNpqntNwaWcugrBjAiHlqqRiVk=
+gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c/go.mod h1:JHkPIbrfpd72SG/EVd6muEfDQjcINNoR0C8j2r3qZ4Q=
+gopkg.in/warnings.v0 v0.1.2 h1:wFXVbFY8DY5/xOe1ECiWdKCzZlxgshcYVNkBHstARME=
+gopkg.in/warnings.v0 v0.1.2/go.mod h1:jksf8JmL6Qr/oQM2OXTHunEvvTAsrWBLb6OOjuVWRNI=
+gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
+gopkg.in/yaml.v2 v2.2.4/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
+gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
+gopkg.in/yaml.v3 v3.0.0 h1:hjy8E9ON/egN1tAYqKb61G10WtihqetD4sz2H+8nIeA=
+gopkg.in/yaml.v3 v3.0.0/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
+rsc.io/pdf v0.1.1/go.mod h1:n8OzWcQ6Sp37PL01nO98y4iUCRdTGarVfzxY20ICaU4=
diff --git a/internal/cfg/config.go b/internal/cfg/config.go
new file mode 100644
index 0000000..bc54119
--- /dev/null
+++ b/internal/cfg/config.go
@@ -0,0 +1,200 @@
+package cfg
+
+import (
+ "fmt"
+ "os"
+ "strconv"
+ "strings"
+
+ "github-file-sync/internal/log"
+)
+
+type Config struct {
+ RepositoryNames []string
+ FilesBindings map[string]string
+
+ IsDryRun bool
+
+ GithubToken string
+ GithubURL string
+
+ CommitMessage string
+ PRTitle string
+ FileSyncBranchRegexp string
+
+ Workspace string // where the repository should be cloned
+ FileSourcePath string // where the source file are stored - set to current dir
+}
+
+// InitConfig based on env variables.
+func InitConfig() (c *Config, err error) { //nolint:cyclop
+ c = new(Config)
+ if c.RepositoryNames, err = getRepositoryNames(); err != nil {
+ return c, err
+ }
+ if c.FilesBindings, err = getFilesBindings(); err != nil {
+ return c, err
+ }
+ if c.IsDryRun, err = getDryRun(); err != nil {
+ return c, err
+ }
+ if c.GithubToken, err = getGithubToken(); err != nil {
+ return c, err
+ }
+ if c.GithubURL, err = getGithubURL(); err != nil {
+ return c, err
+ }
+ if c.CommitMessage, err = getCommitMessage(); err != nil {
+ return c, err
+ }
+ if c.PRTitle, err = getPRTitle(); err != nil {
+ return c, err
+ }
+ if c.FileSyncBranchRegexp, err = getFileSyncBranchRegexp(); err != nil {
+ return c, err
+ }
+ if c.Workspace, err = getWorkspace(); err != nil {
+ return c, err
+ }
+ if c.FileSourcePath, err = os.Getwd(); err != nil {
+ return c, err
+ }
+ return c, nil
+}
+
+// Print the current configuration.
+func (c *Config) Print() {
+ repoNamesStr := ""
+ for _, rn := range c.RepositoryNames {
+ repoNamesStr = fmt.Sprintf("%s\t\t%s\n", repoNamesStr, rn)
+ }
+ fileBindingsStr := ""
+ for src, dest := range c.FilesBindings {
+ fileBindingsStr = fmt.Sprintf("%s\t\t%s -> %s\n", fileBindingsStr, src, dest)
+ }
+ configStr := fmt.Sprintln(
+ "\tRepositories:\n", repoNamesStr,
+ "\tFiles bindings:\n", fileBindingsStr,
+ "\tDry Run:", c.IsDryRun,
+ "\n\tGitHub token set?", (c.GithubToken != ""),
+ "\n\tGithub host URL: ", c.GithubURL,
+ "\n\tCommit message: ", c.CommitMessage,
+ "\n\tFile sync branch regexp: ", c.FileSyncBranchRegexp,
+ "\n\tWorkspace: ", c.Workspace,
+ "\n\tFile Source Path: ", c.FileSourcePath,
+ )
+ fmt.Println(configStr)
+}
+
+func getRepositoryNames() ([]string, error) {
+ // get the raw list from env
+ repoNamesStr := os.Getenv("REPOSITORIES")
+ if repoNamesStr == "" {
+ return nil, fmt.Errorf("REPOSITORIES is empty but required")
+ }
+ // trim spaces
+ repoNamesStr = strings.TrimSpace(repoNamesStr)
+ // split by \n
+ repoNames := strings.Split(repoNamesStr, "\n")
+
+ for _, name := range repoNames {
+ if len(strings.Split(name, "/")) != 2 { //nolint:gomnd
+ return nil, fmt.Errorf("invalid repo name: %s {OWNER}/{NAME} expected", name)
+ }
+ }
+ return repoNames, nil
+}
+
+func getFilesBindings() (map[string]string, error) {
+ // get the raw list from env
+ filesBindingsStr := os.Getenv("FILES_BINDINGS")
+ if filesBindingsStr == "" {
+ return nil, fmt.Errorf("FILES_BINDINGS is empty but required")
+ }
+ // trim spaces
+ filesBindingsStr = strings.TrimSpace(filesBindingsStr)
+ // split by \n
+ fileBindingsList := strings.Split(filesBindingsStr, "\n")
+
+ filesBindings := make(map[string]string, len(fileBindingsList))
+ // split each binding by `=` to build the binding map
+ for _, fileBindingStr := range fileBindingsList {
+ split := strings.Split(fileBindingStr, "=")
+ if len(split) != 2 { //nolint:gomnd
+ return nil, fmt.Errorf("incorrect binding: %s", fileBindingStr)
+ }
+ filesBindings[split[0]] = split[1]
+ }
+
+ // error if no files bindings have been found
+ if len(filesBindings) == 0 {
+ return nil, fmt.Errorf("no valid files bindings found")
+ }
+ return filesBindings, nil
+}
+
+func getDryRun() (bool, error) {
+ isDryRunStr := os.Getenv("DRY_RUN")
+ // default is true
+ if isDryRunStr == "" {
+ log.Infof("DRY_RUN empty: set to default value")
+ return true, nil
+ }
+ return strconv.ParseBool(isDryRunStr)
+}
+
+func getGithubToken() (string, error) {
+ githubToken := os.Getenv("GITHUB_TOKEN")
+ if githubToken == "" {
+ return "", fmt.Errorf("GITHUB_TOKEN is empty but required")
+ }
+ return githubToken, nil
+}
+
+func getGithubURL() (string, error) {
+ githubURL := os.Getenv("GITHUB_URL")
+ if githubURL == "" {
+ return "", fmt.Errorf("GITHUB_URL is empty but required")
+ }
+ return githubURL, nil
+}
+
+func getPRTitle() (string, error) {
+ prTitle := os.Getenv("PR_TITLE")
+ if prTitle == "" {
+ return "", fmt.Errorf("PR_TITLE is empty but required")
+ }
+ // auto-truncate pr title - 100 characters maximum
+ if len(prTitle) > 100 { //nolint:gomnd
+ prTitle = prTitle[:99]
+ }
+ return prTitle, nil
+}
+
+func getCommitMessage() (string, error) {
+ commitMessage := os.Getenv("COMMIT_MESSAGE")
+ if commitMessage == "" {
+ return "", fmt.Errorf("COMMIT_MESSAGE is empty but required")
+ }
+ // auto-truncate commit message - 120 characters maximum
+ if len(commitMessage) > 120 { //nolint:gomnd
+ commitMessage = commitMessage[:119]
+ }
+ return commitMessage, nil
+}
+
+func getFileSyncBranchRegexp() (string, error) {
+ fileSyncBranchRegexp := os.Getenv("FILE_SYNC_BRANCH_REGEXP")
+ if fileSyncBranchRegexp == "" {
+ return "", fmt.Errorf("FILE_SYNC_BRANCH_REGEXP is empty but required")
+ }
+ return fileSyncBranchRegexp, nil
+}
+
+func getWorkspace() (string, error) {
+ workspace := os.Getenv("WORKSPACE")
+ if workspace == "" {
+ return "", fmt.Errorf("WORKSPACE is empty but required")
+ }
+ return workspace, nil
+}
diff --git a/internal/git/repository.go b/internal/git/repository.go
new file mode 100644
index 0000000..c5b1dfb
--- /dev/null
+++ b/internal/git/repository.go
@@ -0,0 +1,197 @@
+package git
+
+import (
+ "context"
+ "fmt"
+ "os"
+ "time"
+
+ "github.com/go-git/go-git/v5"
+ "github.com/go-git/go-git/v5/config"
+ "github.com/go-git/go-git/v5/plumbing"
+ "github.com/go-git/go-git/v5/plumbing/object"
+ "github.com/go-git/go-git/v5/plumbing/transport/http"
+)
+
+type Repository struct {
+ // git config
+ syncBranchName string
+ repoURL string
+ localPath string
+
+ // auth config
+ auth *http.BasicAuth
+ authorName string
+
+ // internal state
+ baseBranchName string // main or master
+ repo *git.Repository
+ workTree *git.Worktree
+ syncRef *plumbing.Reference
+}
+
+// NewRepository clones a repository locally based on given parameters and returns a reference to its object.
+func NewRepository(
+ ctx context.Context,
+ localPath, repoURL, syncBranchName string,
+ auth *http.BasicAuth, authorName string,
+) (*Repository, error) {
+ // init the repository
+ r := &Repository{
+ localPath: localPath,
+ repoURL: repoURL,
+ syncBranchName: syncBranchName,
+
+ auth: auth,
+ authorName: authorName,
+ }
+
+ // try to clone to local path
+ opt := &git.CloneOptions{
+ URL: r.repoURL,
+ Auth: r.auth,
+ }
+ isBare := false
+ repo, err := git.PlainCloneContext(ctx, localPath, isBare, opt)
+ if err != nil {
+ return nil, fmt.Errorf("cloning: %v", err)
+ }
+ r.repo = repo
+
+ return r, nil
+}
+
+// GetBaseBranchName based on the repo.
+// First, it tries to get a "main" branch, then a "master" branch, then it fails.
+func (r *Repository) GetBaseBranchName() (string, error) {
+ if r.baseBranchName == "" {
+ c, err := r.repo.Config()
+ if err != nil {
+ return "", fmt.Errorf("could not get config: %v", err)
+ }
+ r.baseBranchName = "main" // consider naively that it is "main"
+
+ if _, ok := c.Branches["main"]; !ok {
+ if _, ok := c.Branches["master"]; !ok {
+ return "", fmt.Errorf("no base branch found (main|master)")
+ }
+ r.baseBranchName = "master"
+ }
+ }
+ return r.baseBranchName, nil
+}
+
+// GetSyncBranchName.
+func (r *Repository) GetSyncBranchName() string {
+ return r.syncBranchName
+}
+
+// SetSyncBranchName.
+func (r *Repository) SetSyncBranchName(name string) {
+ r.syncBranchName = name
+}
+
+// IsNotSetup returns true if any important internal state variable is not set.
+func (r *Repository) IsNotSetup() bool {
+ return (r.repo == nil ||
+ r.workTree == nil ||
+ r.syncRef == nil)
+}
+
+// Add, Commit, Push from the current local folder to remote.
+func (r *Repository) AddCommitPush(
+ ctx context.Context, commitMsg string,
+) error {
+ // add all files
+ opt := git.AddOptions{
+ All: true,
+ Path: r.localPath,
+ }
+ if err := r.workTree.AddWithOptions(&opt); err != nil {
+ return fmt.Errorf("adding: %v", err)
+ }
+
+ // commit changes
+ commitOpt := &git.CommitOptions{
+ All: true,
+ Author: &object.Signature{
+ Name: r.authorName,
+ When: time.Now(),
+ },
+ }
+ if _, err := r.workTree.Commit(commitMsg, commitOpt); err != nil {
+ return fmt.Errorf("committing: %v", err)
+ }
+
+ // push to remote
+ pushOpt := &git.PushOptions{
+ RemoteName: "origin",
+ Auth: r.auth,
+ Force: true,
+ Atomic: true,
+ }
+ if err := r.repo.PushContext(ctx, pushOpt); err != nil {
+ return fmt.Errorf("pushing: %v", err)
+ }
+ return nil
+}
+
+// ChangesDetected returns true if the git status command returns elements.
+func (r *Repository) ChangeDetected() (bool, error) {
+ statuses, err := r.workTree.Status()
+ if err != nil {
+ return false, fmt.Errorf("getting status: %v", err)
+ }
+ // return true if statuses is non-zero.
+ return (len(statuses) > 0), nil
+}
+
+func (r *Repository) Clean() error {
+ return os.RemoveAll(r.localPath)
+}
+
+// SetupLocalSyncBranch performs low level git operations to setup sync branch,
+// it handles it either a remote branch already exist or if it should be created.
+func (r *Repository) SetupLocalSyncBranch(isNewBranch bool) error {
+ branchConfig := &config.Branch{
+ Name: r.syncBranchName,
+ Rebase: "true",
+ }
+ // a. new branch mode: symbolic ref and branch merge ref are based on the current local head ref
+ // b. existing branch mode: symbolic ref and branch merge ref are based on the existing remote ref
+ syncBranchRefName := plumbing.NewBranchReferenceName(r.syncBranchName)
+ if isNewBranch { // a
+ headRef, err := r.repo.Head()
+ if err != nil {
+ return fmt.Errorf("getting head: %v", err)
+ }
+ r.syncRef = plumbing.NewSymbolicReference(syncBranchRefName, headRef.Name())
+ branchConfig.Merge = r.syncRef.Name()
+ } else { // b
+ remoteRefName := plumbing.NewRemoteReferenceName("origin", r.syncBranchName)
+ r.syncRef = plumbing.NewSymbolicReference(syncBranchRefName, remoteRefName)
+ branchConfig.Merge = r.syncRef.Name()
+ branchConfig.Remote = r.syncBranchName
+ }
+
+ // set the local storer reference
+ if err := r.repo.Storer.SetReference(r.syncRef); err != nil {
+ return fmt.Errorf("setting final ref: %v", err)
+ }
+ // init the work tree
+ var err error
+ r.workTree, err = r.repo.Worktree()
+ if err != nil {
+ return fmt.Errorf("getting worktree: %v", err)
+ }
+ // create the branch reference locally - set the merge to the recently created ref
+ if err := r.repo.CreateBranch(branchConfig); err != nil {
+ return fmt.Errorf("creating remote branch: %v", err)
+ }
+ // checkout the sync ref in the work tree
+ co := &git.CheckoutOptions{Branch: r.syncRef.Name()}
+ if err := r.workTree.Checkout(co); err != nil {
+ return fmt.Errorf("checkout %s: %v", r.syncRef.String(), err)
+ }
+ return nil
+}
diff --git a/internal/github/client.go b/internal/github/client.go
new file mode 100644
index 0000000..93f727c
--- /dev/null
+++ b/internal/github/client.go
@@ -0,0 +1,98 @@
+package github
+
+import (
+ "context"
+ "fmt"
+
+ "github-file-sync/internal/log"
+
+ "github.com/google/go-github/github"
+ "golang.org/x/oauth2"
+)
+
+type Client struct {
+ *github.Client
+}
+
+// NewClient for github with authentication configured.
+func NewClient(ctx context.Context, ghToken string) (Client, error) {
+ ts := oauth2.StaticTokenSource(
+ &oauth2.Token{AccessToken: ghToken},
+ )
+ tc := oauth2.NewClient(ctx, ts)
+ c := github.NewClient(tc)
+ return Client{c}, nil
+}
+
+// GetAuthenticatedUsername return the username of the current authenticated user.
+func (c Client) GetAuthenticatedUsername(ctx context.Context) (string, error) {
+ user, _, err := c.Client.Users.Get(ctx, "") // empty string makes the library returning the authenticated user
+ if err != nil {
+ return "", fmt.Errorf("getting user: %v", err)
+ }
+ if user == nil {
+ return "", fmt.Errorf("retrieved a nil user")
+ }
+ if user.Login == nil {
+ return "", fmt.Errorf("retrieved an empty login")
+ }
+ return *user.Login, nil
+}
+
+// GetHeadBranchNameByPRNumbers for a given repository as a map. Consider only opened PRs.
+func (c Client) GetHeadBranchNameByPRNumbers(ctx context.Context, owner, repoName string) (map[int]string, error) {
+ // max page size is 100: https://docs.github.com/en/rest/pulls/pulls?apiVersion=2022-11-28#list-pull-requests
+ opt := &github.PullRequestListOptions{State: "open", ListOptions: github.ListOptions{Page: 99}}
+
+ prs, _, err := c.Client.PullRequests.List(ctx, owner, repoName, opt)
+ if err != nil {
+ return nil, fmt.Errorf("listing prs: %v", err)
+ }
+ // log a warning if the number of PR retrieved is the maximum page size
+ if len(prs) == 99 { //nolint:gomnd
+ log.Warnf("99 opened PRs on this repository, this may make the synchronization to fail")
+ }
+
+ headBranchNameByPRNumbers := make(map[int]string, len(prs))
+ for _, pr := range prs {
+ if pr.Head.Ref != nil && pr.Number != nil {
+ headBranchNameByPRNumbers[*pr.Number] = *pr.Head.Ref
+ }
+ }
+ return headBranchNameByPRNumbers, nil
+}
+
+// CreateOrUpdatePR according to the existingPRNumber parameter.
+// On update, the desc is added to the Pull Request as a comment.
+func (c Client) CreateOrUpdatePR(
+ ctx context.Context, existingPRNumber *int,
+ owner, repoName,
+ baseBranch, headBranch,
+ title, desc string,
+) error {
+ if existingPRNumber == nil { // create mode
+ canBeModified := true
+ pr := &github.NewPullRequest{
+ Title: &title,
+ Base: &baseBranch,
+ Head: &headBranch,
+ Body: &desc,
+ MaintainerCanModify: &canBeModified,
+ }
+ createdPR, _, err := c.Client.PullRequests.Create(ctx, owner, repoName, pr)
+ if err != nil {
+ return fmt.Errorf("creating PR: %s", err)
+ }
+ log.Infof("PR created: %s", *createdPR.HTMLURL)
+ } else { // update mode = create a comment with the given desc
+ desc = fmt.Sprintf("PR updated with additional changes: %s", desc)
+ prComment, _, err := c.Client.Issues.CreateComment(ctx, owner, repoName, *existingPRNumber, &github.IssueComment{
+ Body: &desc,
+ })
+ if err != nil {
+ return fmt.Errorf("creating comment on PR: %v", err)
+ }
+ log.Infof("PR updated: %s", *prComment.HTMLURL)
+ }
+ return nil
+}
diff --git a/internal/github/helpers.go b/internal/github/helpers.go
new file mode 100644
index 0000000..8e84a5c
--- /dev/null
+++ b/internal/github/helpers.go
@@ -0,0 +1,15 @@
+package github
+
+import (
+ "fmt"
+
+ "github.com/go-git/go-git/v5/plumbing/transport/http"
+)
+
+func GetRepoURL(githubHostURL, repoOwner, repoName string) string {
+ return fmt.Sprintf("https://%s/%s/%s.git", githubHostURL, repoOwner, repoName)
+}
+
+func GetBasicAuth(githubToken string) *http.BasicAuth {
+ return &http.BasicAuth{Username: githubToken, Password: "x-oauth-basic"}
+}
diff --git a/internal/log/log.go b/internal/log/log.go
new file mode 100644
index 0000000..979ad12
--- /dev/null
+++ b/internal/log/log.go
@@ -0,0 +1,67 @@
+package log
+
+import (
+ "context"
+ "fmt"
+ "os"
+ "path/filepath"
+ "runtime"
+ "time"
+
+ "golang.org/x/exp/slog"
+)
+
+// The log record contains the source position of the caller of Infof.
+func Infof(format string, args ...any) {
+ l := slog.Default()
+ if !l.Enabled(context.Background(), slog.LevelInfo) {
+ return
+ }
+ var pcs [1]uintptr
+ // skip [Callers, Infof]
+ runtime.Callers(2, pcs[:]) //nolint:gomnd
+ r := slog.NewRecord(time.Now(), slog.LevelInfo, fmt.Sprintf(format, args...), pcs[0])
+ _ = l.Handler().Handle(context.Background(), r)
+}
+
+// The log record contains the source position of the caller of Errorf.
+func Errorf(format string, args ...any) {
+ l := slog.Default()
+ if !l.Enabled(context.Background(), slog.LevelError) {
+ return
+ }
+ var pcs [1]uintptr
+ // skip [Callers, Errorf]
+ runtime.Callers(2, pcs[:]) //nolint:gomnd
+ r := slog.NewRecord(time.Now(), slog.LevelError, fmt.Sprintf(format, args...), pcs[0])
+ _ = l.Handler().Handle(context.Background(), r)
+}
+
+// The log record contains the source position of the caller of Warnf.
+func Warnf(format string, args ...any) {
+ l := slog.Default()
+ if !l.Enabled(context.Background(), slog.LevelWarn) {
+ return
+ }
+ var pcs [1]uintptr
+ // skip [Callers, Warnf]
+ runtime.Callers(2, pcs[:]) //nolint:gomnd
+ r := slog.NewRecord(time.Now(), slog.LevelWarn, fmt.Sprintf(format, args...), pcs[0])
+ _ = l.Handler().Handle(context.Background(), r)
+}
+
+func Init() {
+ removeTimeAndSourceDirectory := func(groups []string, a slog.Attr) slog.Attr {
+ // Remove time.
+ if a.Key == slog.TimeKey && len(groups) == 0 {
+ a.Key = ""
+ }
+ // Remove the directory from the source's filename.
+ if a.Key == slog.SourceKey {
+ a.Value = slog.StringValue(filepath.Base(a.Value.String()))
+ }
+ return a
+ }
+ logger := slog.New(slog.HandlerOptions{ReplaceAttr: removeTimeAndSourceDirectory}.NewTextHandler(os.Stdout))
+ slog.SetDefault(logger)
+}
diff --git a/internal/sync/manager.go b/internal/sync/manager.go
new file mode 100644
index 0000000..9ca664f
--- /dev/null
+++ b/internal/sync/manager.go
@@ -0,0 +1,67 @@
+package sync
+
+import (
+ "context"
+ "fmt"
+ "strings"
+
+ "github-file-sync/internal/cfg"
+ "github-file-sync/internal/github"
+ "github-file-sync/internal/log"
+)
+
+// Do synchronize one repository.
+func Do(ctx context.Context, repoFullname string, c *cfg.Config, ghClient github.Client) error {
+ log.Infof("Syncing %s...", repoFullname)
+
+ repoFullnameSplit := strings.Split(repoFullname, "/")
+ owner := repoFullnameSplit[0]
+ repoName := repoFullnameSplit[1]
+
+ task, err := NewTask(
+ ctx,
+ owner, repoName,
+ c.FileSourcePath, c.Workspace,
+ c.GithubURL, c.GithubToken, ghClient,
+ c.FileSyncBranchRegexp,
+ c.FilesBindings,
+ )
+ if err != nil {
+ return fmt.Errorf("create repo manager: %v", err)
+ }
+
+ // ensure we clean data at the end of the sync
+ defer func() {
+ cleanErr := task.CleanAll(ctx)
+ if cleanErr != nil {
+ log.Errorf("cleaning %s: %v", repoFullname, cleanErr)
+ }
+ }()
+
+ // compute the sync branch to contribute on
+ // could be a new or existing one
+ err = task.PickSyncBranch(ctx)
+ if err != nil {
+ return fmt.Errorf("picking base branch to compare: %v", err)
+ }
+
+ // check if anything has changed
+ hasChanged, err := task.HasChangedAfterCopy(ctx)
+ if err != nil {
+ return fmt.Errorf("checking for changes: %v", err)
+ }
+
+ if hasChanged {
+ log.Infof("-> it has changed!")
+ if c.IsDryRun {
+ log.Infof("-> dry run: no concrete write action.")
+ } else {
+ if err := task.UpdateRemote(ctx, c.CommitMessage, c.PRTitle); err != nil {
+ return fmt.Errorf("update remote repo: %v", err)
+ }
+ }
+ } else {
+ log.Infof("-> nothing has changed.")
+ }
+ return nil
+}
diff --git a/internal/sync/task.go b/internal/sync/task.go
new file mode 100644
index 0000000..e074edc
--- /dev/null
+++ b/internal/sync/task.go
@@ -0,0 +1,189 @@
+package sync
+
+import (
+ "context"
+ "fmt"
+ "path"
+ "regexp"
+ "time"
+
+ "github-file-sync/internal/git"
+ "github-file-sync/internal/github"
+ "github-file-sync/internal/log"
+
+ cp "github.com/otiai10/copy"
+)
+
+// Task is a handler which synchronizes a git repository files on github with current filesystem and given rules called file bindings.
+type Task struct {
+ // repo config
+ repoName string
+ owner string
+
+ // local tmp file config
+ sourcePath string
+ targetPath string
+
+ // github config
+ ghHostURL string
+ ghToken string
+ ghClient github.Client
+
+ // git config
+ gitRepo *git.Repository
+
+ // additional config
+ fileSyncBranchRegexp *regexp.Regexp
+ fileBindings map[string]string
+
+ // internal state
+
+ // existingPRNumber indicates if a PR and a branch should be created, and what is the existing PR number
+ // there is no distinction between the PR & the branch for now:
+ // it is set based on opened PR: if a sync branch exists without a PR, it is either ignored or results in an error
+ existingPRNumber *int
+}
+
+// NewTask configured with default values and given parameters.
+// One task per repository.
+func NewTask(
+ ctx context.Context,
+ owner, repoName,
+ baseSourcePath, baseTargetPath,
+ ghURL, ghToken string,
+ ghClient github.Client,
+ fileSyncBranchRegexpStr string,
+ fileBindings map[string]string,
+) (t Task, err error) {
+ // init the repo RepositoryManager
+ t = Task{
+ repoName: repoName,
+ owner: owner,
+
+ sourcePath: baseSourcePath,
+ targetPath: path.Join(baseTargetPath, owner, repoName),
+
+ ghHostURL: ghURL,
+ ghToken: ghToken,
+ ghClient: ghClient,
+
+ fileSyncBranchRegexp: regexp.MustCompile(fileSyncBranchRegexpStr),
+ fileBindings: fileBindings,
+
+ existingPRNumber: nil, // by default, consider creating a new PR
+ }
+
+ // add to the repo RepositoryManager the author information
+ authorName, err := ghClient.GetAuthenticatedUsername(ctx)
+ if err != nil {
+ return t, err
+ }
+ defaultBranchName := fmt.Sprintf("%s-sync-file-pr", time.Now().Format("2006-01-02"))
+ t.gitRepo, err = git.NewRepository(
+ ctx,
+ t.targetPath,
+ github.GetRepoURL(t.ghHostURL, t.owner, t.repoName), defaultBranchName,
+ github.GetBasicAuth(t.ghToken), authorName,
+ )
+ return t, err
+}
+
+// PickSyncBranch on the repo which will be used to compare files and push potential changes
+// could be:
+// - a new branch based on the repo's HEAD: probably main or master.
+// - an existing file sync branch.
+func (t *Task) PickSyncBranch(ctx context.Context) error {
+ // try to find an existing file sync branch by checking opened PRs
+ branchNameByPRNumbers, err := t.ghClient.GetHeadBranchNameByPRNumbers(ctx, t.owner, t.repoName)
+ if err != nil {
+ return fmt.Errorf("getting branches: %v", err)
+ }
+
+ // try to find an existing file sync PR
+ alreadyFound := false
+ for prNumber, branchName := range branchNameByPRNumbers {
+ // use branch name to see if it is an file sync PR
+ // skip it if it doesn't match
+ if !t.fileSyncBranchRegexp.MatchString(branchName) {
+ continue
+ }
+
+ // if any sync PR was already found, raise a warning about it, keep the first one found by breaking the loop
+ if alreadyFound {
+ log.Warnf("it seems there are two existing file sync pull requests on repo %s", t.repoName)
+ break
+ }
+ // set the existing sync branch and existing PR
+ t.gitRepo.SetSyncBranchName(branchName)
+ t.existingPRNumber = new(int)
+ *t.existingPRNumber = prNumber
+
+ alreadyFound = true
+ }
+
+ // configure the branch locally
+ isNewBranch := (t.existingPRNumber == nil)
+ if err := t.gitRepo.SetupLocalSyncBranch(isNewBranch); err != nil {
+ return fmt.Errorf("setting up sync branch locally: %v", err)
+ }
+ return nil
+}
+
+// HasChangedAfterCopy first updates local files following binding rules,
+// then checks the git status and returns true if something has changed.
+func (t *Task) HasChangedAfterCopy(ctx context.Context) (bool, error) {
+ // return directly if no files bindings defined
+ if len(t.fileBindings) == 0 {
+ return false, nil
+ }
+
+ // local git repo should be setup
+ if t.gitRepo.IsNotSetup() {
+ return false, fmt.Errorf("local git repo is not setup correctly")
+ }
+
+ // 2. copy files from the current repo to the repo-to-sync local path
+ // according to configured bindings
+ notAnyCopySuccess := true
+ for src, dest := range t.fileBindings {
+ // build absolute path to copy
+ src = path.Join(t.sourcePath, src)
+ dest = path.Join(t.targetPath, dest)
+
+ if err := cp.Copy(src, dest); err != nil {
+ log.Errorf("copying %s to %s: %v", src, dest, err)
+ continue
+ }
+
+ notAnyCopySuccess = false
+ }
+ if notAnyCopySuccess {
+ return false, fmt.Errorf("not able to copy any file")
+ }
+
+ // 3. consider if files have changed
+ return t.gitRepo.ChangeDetected()
+}
+
+func (t *Task) UpdateRemote(ctx context.Context, commitMsg, prTitle string) error {
+ if err := t.gitRepo.AddCommitPush(ctx, commitMsg); err != nil {
+ return err
+ }
+ baseBranchName, err := t.gitRepo.GetBaseBranchName()
+ if err != nil {
+ return err
+ }
+ if err := t.ghClient.CreateOrUpdatePR(
+ ctx, t.existingPRNumber,
+ t.owner, t.repoName,
+ baseBranchName, t.gitRepo.GetSyncBranchName(),
+ prTitle, commitMsg,
+ ); err != nil {
+ return err
+ }
+ return nil
+}
+
+func (t *Task) CleanAll(ctx context.Context) error {
+ return t.gitRepo.Clean()
+}
diff --git a/main.go b/main.go
new file mode 100644
index 0000000..a2b0d5b
--- /dev/null
+++ b/main.go
@@ -0,0 +1,43 @@
+package main
+
+import (
+ "context"
+ "os"
+
+ "github-file-sync/internal/cfg"
+ "github-file-sync/internal/github"
+ "github-file-sync/internal/log"
+ "github-file-sync/internal/sync"
+)
+
+func main() {
+ ctx := context.Background()
+
+ // init of logger
+ log.Init()
+
+ // init of config
+ log.Infof("Configuration...")
+ config, err := cfg.InitConfig()
+ if err != nil {
+ log.Errorf("initing config: %v", err)
+ os.Exit(1)
+ }
+ config.Print()
+
+ // init of github client
+ ghClient, err := github.NewClient(ctx, config.GithubToken)
+ if err != nil {
+ log.Errorf("initing github client: %v", err)
+ os.Exit(1)
+ }
+
+ // start synchronization
+ log.Infof("Let's sync")
+ for _, repoName := range config.RepositoryNames {
+ if err := sync.Do(ctx, repoName, config, ghClient); err != nil {
+ log.Errorf("syncing %s: %v", repoName, err)
+ }
+ }
+ log.Infof("Sync finished.")
+}