Commit 0294b62e authored by Steve Revill's avatar Steve Revill
Browse files

Initial import of the ABRelease component.

parents
ABRelease
=========
This component is designed to be inserted into builds (any type of build) so
that they can more fully interact with the Autobuild system.
HOW IT WORKS
The ABRelease component will run a build-specifiy script (obey file) for each
phase of the build process to allow any special behaviour to take place. To
do this, it will invoke the script by running it from a specific path, which
includes (in this order) the following Resources subdirectories:
1. Resources.<Name of Autobuild build> - e.g. "TungstenDev"
2. Resources.<Name of build> - e.g. "Tungsten"
3. Resources.Generic
The script that is executed has a leafname which matches that of the phase it
will be run during, for example:
Resources.TungstenDev.clean - run in the "clean" phase
If no script file is found for a given phase of a specific build, then no
action is taken by this component in that build phase.
THE DEFAULT SCRIPT
By default, only one phase has a corresponding obey file, and this will be
executed by any build, unless overridden by placing a script with the same
leafname into an earlier directory on the path. This default script is:
Resources.Generic.release_autobuild
There are a few things to note about this script:
1. It is only executed during the "release_autobuild" phase of the build
process, so this won't happen when the build is initiated by !Builder,
because that doesn't perform the "release_autobuild" phase. Normally,
only the Autobuild process itself will run "release_autobuild" as the
final build phase.
2. This default script assumes a ROM build. It will create a zip archive
which includes a copy of the Castle licence, a ReadMe text file and the
ROM image (if found) and upload the archive onto the Autobuild server.
3. All of the scripts are called with a single parameter, which is the
INSTDIR build variable. This will be particularly useful for disc builds
to locate the installed components.
For disc builds, there will need to be a "release_autobuild" script placed
earlier on the path which will do whatever packaging up and uploading is
required.
The default script will perform the following actions:
* If there is no ROM image (e.g. the build failed), exit here IfThere
* If SparkFS isn't running, we're going to have problems so generate error
* Remove any old template zip archive from our resources directory Remove
* Copy the central template zip archive into our resources directory
* Open the archive so we can copy into it
* Copy a ReadMe file into the zip archive
* Copy the ROM image into the zip archive
* Close the archive (filer window)
* Delete any pre-existing zip archive on the autobuild server
* Copy the template zip archive onto the autobuild server
* Remove the template zip archive from our resources directory
There is also a default script for the "clean" phase which deletes any copy
of the template zip archive from the Resources.<Name of Autobuild build>
directory (if there is one). This is really little more than an example.
ENVIRONMENT VARIABLES
In order to make writing these scripts easier, the ABRelease script sets up
some environment variables before looking for and runnnig the script for a
given build phase (if it exists):
ab_res$dir - the Autobuild resource directory (e.g. Resources.TungstenDev)
ab_red$path - the Resources path, as described above
ab_build$dir - the directory on the Autobuild server to upload into
ab_build$path - path to ab_build$dir - for convenience
ab_zip$file - the name of the zipfile to create on the Autobuild server (if any)
Note: some types of build might upload something other than a single zipfile
into their upload directory. In that case, the ab_zip$file variable can be
ignored.
FINAL NOTES
The Resources.Generic directory includes some resources which are generically
useful for builds, these are:
* A template zip archive containing a copy of the Castle licence (PDF)
* A template ReadMe text file containing only some generic information
* A utility (NullEvent) to cause a Task Window to sleep for a Wimp poll
The NullEvent utility is useful for putting between operations in a script in
order to ensure that some processing gets handed back to other Winp tasks.
This is useful for two reasons:
1. It allows the contents of the Task Window to update on screen and give a
better indication of progress
2. Things like Filer_Run and Filer_Boot have a chance to execute
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
# Copyright 2009 Castle Technology Ltd
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# Makefile for Autobuild
#
# This component should be placed into (disc) builds as the final component
# so that it can perform any final installation tasks, such as copying files
# into archives, adding pre-built binaries, etc.
#
# If we're not running in an autobuild environemnt (i.e. AutoBuild$InstScript
# is unset) then this component will not do anything.
include StdTools
COMPONENT=ABRelease
clean clean_all export_hdrs export_libs rom install install_rom release_autobuild resources:
@Set ab_res$dir Resources.<Autobuild$Build>
@Set ab_res$path <ab_res$dir>.,Resources.<Build>.,Resources.Generic.
@Set ab_build$dir <AutoBuild$Root>.builds.<Autobuild$Build>
@Set ab_build$path <ab_build$dir>.
@Set ab_zip$file ab_build:<Autobuild$Build>/zip
@If "<Autobuild$Build>" <> "" Then Do mkdir -p <ab_build$dir>
@If "<Autobuild$Build>" <> "" Then IfThere ab_res:$@ Then Obey -v ab_res:$@ ${INSTDIR}
@echo ${COMPONENT}: $@: complete
| Copyright 2009 Castle Technology Ltd
|
| Licensed under the Apache License, Version 2.0 (the "License");
| you may not use this file except in compliance with the License.
| You may obtain a copy of the License at
|
| http://www.apache.org/licenses/LICENSE-2.0
|
| Unless required by applicable law or agreed to in writing, software
| distributed under the License is distributed on an "AS IS" BASIS,
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
| See the License for the specific language governing permissions and
| limitations under the License.
|
Dir <Obey$Dir>
amu_machine release_autobuild INSTDIR=<Install$Dir>
\ No newline at end of file
| Copyright 2009 Castle Technology Ltd
|
| Licensed under the Apache License, Version 2.0 (the "License");
| you may not use this file except in compliance with the License.
| You may obtain a copy of the License at
|
| http://www.apache.org/licenses/LICENSE-2.0
|
| Unless required by applicable law or agreed to in writing, software
| distributed under the License is distributed on an "AS IS" BASIS,
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
| See the License for the specific language governing permissions and
| limitations under the License.
|
Dir <Obey$Dir>
amu_machine clean INSTDIR=<Install$Dir>
\ No newline at end of file
RISC OS Open Release Archive
============================
Some components in this archive are released under the licence (included in
this archive as Licence_v1.pdf), or see:
http://www.castle-technology.co.uk/riscosbaselicence.htm
-- RISC OS Open
| Copyright 2009 Castle Technology Ltd
|
| Licensed under the Apache License, Version 2.0 (the "License");
| you may not use this file except in compliance with the License.
| You may obtain a copy of the License at
|
| http://www.apache.org/licenses/LICENSE-2.0
|
| Unless required by applicable law or agreed to in writing, software
| distributed under the License is distributed on an "AS IS" BASIS,
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
| See the License for the specific language governing permissions and
| limitations under the License.
|
| Remove any old template zip archive from our resources directory
Remove <ab_res$dir>.zip
\ No newline at end of file
| Copyright 2009 Castle Technology Ltd
|
| Licensed under the Apache License, Version 2.0 (the "License");
| you may not use this file except in compliance with the License.
| You may obtain a copy of the License at
|
| http://www.apache.org/licenses/LICENSE-2.0
|
| Unless required by applicable law or agreed to in writing, software
| distributed under the License is distributed on an "AS IS" BASIS,
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
| See the License for the specific language governing permissions and
| limitations under the License.
|
| If there is no ROM image (e.g. the build failed), exit here
IfThere <Build$Dir>.Images.<Build$ImageName> Then Else Obey
| If SparkFS isn't running, we're going to have problems so generate error
RMEnsure SparkFS 0.00 Error ABRelease: release_autobuild: requires SparkFS to be present
RMEnsure Zip 0.00 Error ABRelease: release_autobuild: requires the SparkFS Zip module to be present
| Remove any old template zip archive from our resources directory
Remove <ab_res$dir>.zip
| Copy the central template zip archive into our resources directory
Do Copy ab_res:zip <ab_res$dir>.zip ~cfr~v
Run ab_res:NullEvent
| Open the archive so we can copy into it
Do Filer_Run <ab_res$dir>.zip
Run ab_res:NullEvent
| Copy a ReadMe file into the zip archive
Copy ab_res:ReadMe/txt <ab_res$dir>.zip.ReadMe/txt ~cfr~v
| Copy the ROM image into the zip archive
Copy <Build$Dir>.Images.<Build$ImageName> <ab_res$dir>.zip.<Autobuild$Build> ~cfr~v
Run ab_res:NullEvent
| Close the archive (filer window)
Do Filer_CloseDir <ab_res$dir>.zip
Run ab_res:NullEvent
| Delete any pre-existing zip archive on the autobuild server
Remove <ab_zip$file>
| Copy the template zip archive onto the autobuild server
Copy <ab_res$dir>.zip <ab_zip$file> ~cfr~v
| Remove the template zip archive from our resources directory
Remove <ab_res$dir>.zip
\ No newline at end of file
RISC OS Open Release Archive
============================
This is the IOMD (A7000 and RiscPC) development ROM image. It is a
bleeding-edge build which comes from the latest revisions of all the relevant
sources in our source code repository and is completely untested.
Softloading this ROM image should only be done if you are confident that you
know what you are doing and have a good backup strategy in place! It is
likely to be incomplete and only partially functional.
Some components in this archive are released under the licence (included in
this archive as Licence_v1.pdf), or see:
http://www.castle-technology.co.uk/riscosbaselicence.htm
-- RISC OS Open
RISC OS Open Release Archive
============================
This is the OMAP (Beagle Board) development ROM image. It is a bleeding-edge
build which comes from the latest revisions of all the relevant sources in
our source code repository and is completely untested.
Using this ROM image in your Beagle should only be done if you are confident
that you know what you are doing! It is likely to be functionally incomplete
and probably unstable in various ways.
Some components in this archive are released under the licence (included in
this archive as Licence_v1.pdf), or see:
http://www.castle-technology.co.uk/riscosbaselicence.htm
-- RISC OS Open
RISC OS Open Release Archive
============================
This is the IYONIX (codename Tungsten) development ROM image. It represents
the last ROOL build of the IYONIX ROM image, but does not always
correspond with a formal ROM release. Because ROOL don't perform regular
builds and testing of ROM releases, this ROM is likely to contain components
which are quite a lot older than in the TungstenDev build.
You MUST NOT attempt to program this into the flash of your IYONIX - even
softloading it should only be done if you are confident that you know what
you are doing and have a good backup strategy in place!
Some components in this archive are released under the licence (included in
this archive as Licence_v1.pdf), or see:
http://www.castle-technology.co.uk/riscosbaselicence.htm
-- RISC OS Open
RISC OS Open Release Archive
============================
This is the IYONIX (codename Tungsten) development ROM image. It is a
bleeding-edge build which comes from the latest revisions of all the relevant
sources in our source code repository and is completely untested. As such,
you MUST NOT attempt to program this into the flash of your IYONIX - even
softloading it should only be done if you are confident that you know what
you are doing and have a good backup strategy in place!
Some components in this archive are released under the licence (included in
this archive as Licence_v1.pdf), or see:
http://www.castle-technology.co.uk/riscosbaselicence.htm
-- RISC OS Open
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment