-
Notifications
You must be signed in to change notification settings - Fork 9
release
Release the activity to be used by users.
(A release of an activity consists of three aspects: its state, its version number and viewers -- or target public. The release command allows the user to control those three pieces of data in a consistent way).
The primary purpose of the release command is to make an activity visible to users. However, it can also be used to control the activity state as well as to configure its target public.
If used without argument, the release command prints out a brief report on the release status of the activity and makes no changes at all. To effectively release an activity, at least one option must be used. The option --to (or --user) can be used while the activity is in draft state to make the activity visible to individual users. This allows the users to see and assign the activity to themselves as evaluation assignments (thus, they are not counted as group work). The option --to cannot be used after the activity is effectively released.
The --group option is used to effectively release the activiy. When this option is used, the activity state changes from draft to enabled and its version number goes from 0.x.x to 1.0.0. From this point on, all assignments will be created as effective work group.
Once the activity is effectively released (or once the state goes from draft to enabled) the release command can be used to investigate the current state of the release (without any options) and to further adjust the target public (with the --group option). While the --user option cannot be used anymore. The command can also be used to temporarily disable and re-enable to the activity. When the activity is disabled, it is not listed anymore and no new assignments can be created. To do this, use the options --disable and --enable. These two options cannot be used while the activity is in draft state.
tst release
Use the syntax above to get a brief report on the current release state of the activity. It can be used in any state and has no effects on the activity at all.
tst release --user <username>... [--unit <unitname>]
Use the syntax above to pre-release the activity to individual users. This is useful during the development of the activity. It makes the activity visible to those specific users so they can create evaluation assignments to themselves. Observe that users are added to the list of users who can view the activity. The unit is optional. If it is not used the generic * unit will be used (which is accepted by all groups). This syntax doesn't change the state or the version number of the activity.
tst release [--group {<groupname>,:none,:all}] --unit <unitname>
Use this syntax to effectively release the activity to the users of a group. If no group is named, the default value is used -- the user's current group for students and none, otherwise). Observe that the indication of the unit is mandatory and must use a valid unit name for the intended group. When this syntax is used for the first time, the state of the activity is changed from draft to enabled and its version number is changed from 0.x.x to 1.0.0. When it is used after the activity has already been released, it only adds the group to the list of viewers of the activity or changes the unit to use with the activity in that group.
tst release --disable
tst release --enabled
Use this syntax to change the state of the activity either to disabled or to --enabled (see activity states). This affects only the state of the activity.